Support for Drupal 7 is ending on 5 January 2025—it’s time to migrate to Drupal 10! Learn about the many benefits of Drupal 10 and find migration tools in our resource center.
Need to replace the word e.g. with "for example" or "for instance" and i.e. with "that is" English literals in the in core/module A-L
Note: Frequently, the replacement of text with 'for instance' or 'for example' requires the re-wrapping of docblocks and code comments to be near but less than 80 characters.
Comment | File | Size | Author |
---|---|---|---|
#106 | 23462solve_example_that_is.patch | 1.7 KB | hi_ten_ja |
#106 | interdiff_23462solve_example_that_is.txt | 1.7 KB | hi_ten_ja |
#104 | interdiff-2640718-97-104.txt | 2.46 KB | rakesh.gectcr |
#104 | 2640718-104.patch | 67.12 KB | rakesh.gectcr |
#103 | interdiffff-2640718-94-97.txt | 5.11 KB | rakesh.gectcr |
Comments
Comment #2
Lars Toomre CreditAttribution: Lars Toomre as a volunteer commentedAttached is an initial patch for this round of eradicating 'e.g.' from the documentation and code comments. This is a bit bigger than the 50k target, but covers all occurrences in core/modules/s*.
Comment #3
Lars Toomre CreditAttribution: Lars Toomre as a volunteer commentedWhoops... Forgot to change the status.
Comment #4
jhodgdonThanks -- mostly looks great! A few small things to fix:
In the original, the close paren was after "drupalCreateUser()". You've moved it down. I think this was not right.
Before a - list we normally want the previous line to end in : as it did before this patch. Usually it would say "For example:" here I think not "for instance" too?
In the original, the close paren was after "drupalCreateUser()". You've moved it down. I think this was not right.
Um, really null? What would that mean?
Really a LOT of this patch, including this bit, is way out of scope for this issue...
I think the "for instance" part here should be in () for clarity. The comma punctuation is not good.
How about just:
PHP image type constant, such as IMAGETYPE_JPEG.
These two lines I think should not have been removed from the test?
Actually I think the methods/variables in this class can just use @inheritdoc???
Suggestion:
PHP image type constant, such as IMAGETYPE_JPEG.
Comment #5
jhodgdonAlso... As per discussion on that other issue... We need to limit the scope of this issue to only e.g. and i.e. fixes, and take out all the other fixes.
Comment #6
imalabyaComment #7
imalabyaComment #8
imalabyaHave changed the target folder irrespective of the first patch because anyways it was falling out of scope. Multiple folders are targeted because not too many instances are there in the folders combined.
Comment #9
aditya_anurag CreditAttribution: aditya_anurag as a volunteer and at Valuebound commentedreplaced i.e. with "that is"
Comment #10
aditya_anurag CreditAttribution: aditya_anurag as a volunteer and at Valuebound commentedAlso replaced "e.g" to "for example"
Comment #12
jhodgdonThanks for the patches! I think the test failure is not related to this patch.
However, this patch needs some work:
The correct punctuation for "for example" and "that is" in sentences like this would be:
... is missing; that is, when no ...
If you do not fix the punctuation (which is the case in this entire patch), in many places you make the sentence have a completely different meaning or it is very difficult to read.
I started to review the patch but it needs work for punctuation throughout.
Also please note that in many places in Core, people have used i.e. where they should have used e.g., and vice versa. So you need to read the documentation and check whether they really meant "for example" or "for instance" or "that is". In some cases, the correct fix might be to rewrite the sentence, adding some parentheses, or something like that, and in some cases, you might need to replace an i.e. that was misused to be "for example" instead of "that is". So please take a more careful look when making the next patch.
Thanks!
Comment #13
aditya_anurag CreditAttribution: aditya_anurag as a volunteer and at Valuebound commentedThanks for Suggestion. I will work on the suggested change.
Comment #14
aditya_anurag CreditAttribution: aditya_anurag as a volunteer and at Valuebound commentedComment #15
imalabya"such as" is more suitable here. thoughts?
need to rephrase, not making much sense.
"which is" suits better
"(that is, internal) plugins" -> even implicitly loaded plugin, which are internal plugins,..
same here as above. Also need one more space in the second line.
it says "Set up two default input format" but one is written.
false need to be FALSE
this needs to be replaced with "For example"
needs a comma before "for example" and after attribute
and
<p>
)"),Annotations are not a part of the scope.
"like" or "such as" suits better IMO
Comment #16
himanshugautam CreditAttribution: himanshugautam commentedchanges made as per comment #15
Comment #17
himanshugautam CreditAttribution: himanshugautam commentedComment #19
jhodgdonWe usually name the interdiff files with a .txt extension so that they don't get tested as patches. ;)
Comment #20
jhodgdonOn #2637336-33: Replace i.e. and e.g. with English words in /core/includes and /core/misc directory, catch pointed out that we need a Coder/DrupalCS rule before any of these issues can be committed. See
https://www.drupal.org/core/scope#coding-standards
So I will delay reviewing any more on these issues until that is done.
Comment #23
Munavijayalakshmi CreditAttribution: Munavijayalakshmi at Valuebound commentedLine exceeding 80 characters
Line exceeding 80 characters
Line exceeding 80 characters
Line exceeding 80 characters
Comment #24
Munavijayalakshmi CreditAttribution: Munavijayalakshmi at Valuebound commentedComment #25
himanshu-dixit CreditAttribution: himanshu-dixit as a volunteer commented.
Comment #26
saurabh rawat CreditAttribution: saurabh rawat as a volunteer commentedComment #27
saurabh rawat CreditAttribution: saurabh rawat as a volunteer commentedComment #28
dhruveshdtripathi CreditAttribution: dhruveshdtripathi as a volunteer and at DevsAdda for OpenSense Labs commentedGetting warnings after applying patch #27.
warning: squelched 14 whitespace errors
warning: 19 lines add whitespace errors.
Comment #29
tameeshb CreditAttribution: tameeshb at Google Summer of Code commentedMultiple comments in #27 exceed the 80 character limit.
Comment #30
himanshu-dixit CreditAttribution: himanshu-dixit as a volunteer commentedComment #31
himanshu-dixit CreditAttribution: himanshu-dixit as a volunteer commentedComment #32
Munavijayalakshmi CreditAttribution: Munavijayalakshmi at Valuebound commentedFixed #28 and #29.
Comment #33
darius.restivan CreditAttribution: darius.restivan commentedSome of the "e.g"s were replaced at the beginning of a sentance with "for example", where the F should be a capital letter.
Comment #34
boaloysius CreditAttribution: boaloysius as a volunteer commentedComment #36
boaloysius CreditAttribution: boaloysius as a volunteer commentedComment #37
gaurav.kapoor CreditAttribution: gaurav.kapoor at OpenSense Labs commentedComment #38
gaurav.kapoor CreditAttribution: gaurav.kapoor at OpenSense Labs commentedComment #39
gaurav.kapoor CreditAttribution: gaurav.kapoor at OpenSense Labs commentedThis much should be reviewed and fixed quickly or else we will end up creating new patch again and again.
Comment #40
jofitz CreditAttribution: jofitz at ComputerMinds commentedRemoved Needs Reroll tag.
Comment #41
boaloysius CreditAttribution: boaloysius as a volunteer and at Google Summer of Code commentedComment #42
seancgraham CreditAttribution: seancgraham commentedWe (me and ghostinthemachines) are working on testing this (Drupal Con novice sprinters). We are having trouble applying the patch. Hunk #1 Failed at 59.
Comment #43
ruthleopold CreditAttribution: ruthleopold commentedI tried to apply this patch, it didn't work so I rerolled it.
Comment #45
ZeiP CreditAttribution: ZeiP at Citrus Solutions Oy commentedThe last few patches had gone quite far from the issue scope (the e.g. replacements were mostly missing, there were quite a bit of unrelated changes and changes for files outside core/modules/[a-l]*). Attached is a new patch only replacing all the instances. Probably requires still quite a bit of rewording and after that coding standards checks.
Comment #47
MaskyS CreditAttribution: MaskyS at Google Code-In commentedTaking this one ;)
Comment #49
mohit1604 CreditAttribution: mohit1604 at Google Summer of Code commentedComment #50
mohit1604 CreditAttribution: mohit1604 at Google Summer of Code commentedPatch for 8.6.x , Thanks :)
Comment #52
mohit1604 CreditAttribution: mohit1604 at Google Summer of Code commentedInterdiff of patch #50 and #52 .
Comment #53
jofitz CreditAttribution: jofitz at ComputerMinds commentedComment #54
Michelle-Buckby CreditAttribution: Michelle-Buckby as a volunteer commentedWorking on this issue, reviewing how the patch works from comment #52.
Comment #55
recluso CreditAttribution: recluso as a volunteer commentedPatch applied successfully, but there are white space warnings.
Lines 63 and 64 are in jquery.js. As in third party file do not know what to do.
Comment #56
recluso CreditAttribution: recluso as a volunteer commentedNeeds reroll
Comment #57
mohit1604 CreditAttribution: mohit1604 at Google Summer of Code commentedComment #58
mohit1604 CreditAttribution: mohit1604 at Google Summer of Code commentedFixing warnings and error as per comment #55 and #56 , Please review it , Thank you :)
Comment #59
mohit1604 CreditAttribution: mohit1604 at Google Summer of Code commentedComment #61
mohit1604 CreditAttribution: mohit1604 at Google Summer of Code commentedComment #63
mohit1604 CreditAttribution: mohit1604 at Google Summer of Code commentedComment #64
andrewmacpherson CreditAttribution: andrewmacpherson as a volunteer and at Annertech commentedFirst-time contributors worked on this at a sprint workshop in Leeds UK
Comment #65
welly CreditAttribution: welly at Fat Beehive commentedPatch applied correctly but found some missing/additional i.e. and e.g. Have updated the patch, and added an interdiff.
Comment #67
welly CreditAttribution: welly at Fat Beehive commentedCleaned up patch
Comment #68
welly CreditAttribution: welly at Fat Beehive commentedComment #69
bhanuprakashnani CreditAttribution: bhanuprakashnani at Google Summer of Code commentedPatch applies cleanly. Changes made are sufficient.
Comment #70
cilefen CreditAttribution: cilefen at Institute for Advanced Study commentedWhat's the deal with indentations changing?
This does not make sense.
This is not clear. "In other words" would perhaps make more sense here.
Try "(the directory)" or "(that is, the directory)".
This makes no sense and actually may be misinformation.
I am going to stop here. I want to be clear that this may not be a find and replace operation only. Please read each replacement for grammar and to be sure meaning is preserved.
Thanks you!
Comment #71
Mayuresh7 CreditAttribution: Mayuresh7 commentedI am working on it.
Comment #72
apadernoI agree that i.e. and e.g. are sometimes over-used, but always replacing them and always replacing them with the same phrase are both incorrect. Let's just use them for list or words.
For example, it doesn't make sense in Returns the base URL path (i.e., directory) of the Drupal installation. where the parenthetical is sufficient.
Comment #73
chiranjeeb2410 CreditAttribution: chiranjeeb2410 at Google Summer of Code commented@cilefen,
Addressed issues 2,3,4 & 5 as suggested. Also, attached interdiff alongwith patch.
Please review.
Comment #75
chiranjeeb2410 CreditAttribution: chiranjeeb2410 at Google Summer of Code commentedAttached correct patch. Hope it shows green.
Please review.
Comment #76
apadernoThe indentation is still changed.
The previous sentence ends with a semicolon, so the next one doesn't need to start with a capital letter.
Also, in this case i.e. is not necessary. Just use a parenthetical.
Also, there is no need to use that is either.
In this case, i.e. is fine, since it is followed from an exhaustive list. In American English, Oxford comma is used.
I am not sure the parenthetical is needed. file permission should be sufficient. If there is possibility of confusion, I would rather say UNIX file permissions. Yes, I would use the plural because it's not just a simple permission.
That is wrong already: Before i.e. there should not be a semicolon, and in that case there is no need to use i.e..
In this case, the use of i.e. is correct because follows an exhaustive list. It is also not necessary.
Just use (desktops).
Just remove I.e. and capitalize the next word.
As alternative, I would use the following.
Let's go straight to the point, instead of using an "abstract" phrase that needs to be explained.
That is a perfect example of when not use i.e. Just remove it.
Replace it with which means.
(I apologize this review is not complete.)
Comment #77
chiranjeeb2410 CreditAttribution: chiranjeeb2410 at Google Summer of Code commented@kiamlaluno,
Uploaded patch contains all above-mentioned changes. Please review accordingly.
Hope to show greem.
Comment #78
cilefen CreditAttribution: cilefen at Institute for Advanced Study commentedWe do not manage file contents in core/assets/vendor.
Looking at merely one instance, I see two things wrong. First, the sentence makes even less sense now. Second, it exceeds 80 columns. This is not simply a find and replace job.
Comment #79
cilefen CreditAttribution: cilefen at Institute for Advanced Study commentedAlso, this issue title is "Replace i.e. and e.g. with English words in core/module A-L" and every patch lately is doing much more than that.
Comment #80
apadernoThat is because, in some cases, the sentence is using i.e. when it should not, and removing it is only possible by rephrasing the sentence. A sentence should not use i.e. merely as shortcut for another phrase, or just to use it.
The correct description for the issue is "remove/replace i.e. and e.g. when possible." Simply replacing every occurrence is wrong, in the same way it is wrong replacing every occurrence with the same phrase.
Comment #81
apadernoFor example, in the following sentence, i.e. should not be even used.
Removing it requires to require the phrase, though.
Comment #82
savkaviktor16@gmail.com CreditAttribution: savkaviktor16@gmail.com at Skilld commentedthe patch applies cleanly
Comment #83
apadernoI understand there are three different patches, but there should be changes that are applied equally to all of them.
Comment #84
apadernoActually, the patch provided here is changing the wrong files: It should change the files in core/modules, not other directories. In particular, it should change the files in the following directories.
Comment #85
chiranjeeb2410 CreditAttribution: chiranjeeb2410 at Google Summer of Code commented@kiamlaluno,
That's a lot of files to handle though.
Comment #86
cilefen CreditAttribution: cilefen at Institute for Advanced Study commentedThus what I wrote in #79.
Comment #87
apaderno@chiranjeeb2410 Three issues have been created to replace i.e. and e.g. and each of them handles a specific set of files.
Comment #88
apaderno@cilefen I apologize: I thought that by doing much more than that you meant doing more than simply replacing "i.e." and "e.g." I understood what you meant after I looked at the other issues.
Comment #89
hi_ten_ja CreditAttribution: hi_ten_ja commentedIs it easiet issueto solve?
Comment #90
ankitjain28may CreditAttribution: ankitjain28may as a volunteer and at Google Summer of Code commentedI have fixed all the files within directory range A-L in the modules folder, please review.
This simple command fixed it in a sec.
find ./a* ./b* ./c* ./d* ./e* ./f* ./g* ./h* ./i* ./j* ./k* ./l* -type f -exec sed -i 's/i\.e\./that is/g' {} \;
find ./a* ./b* ./c* ./d* ./e* ./f* ./g* ./h* ./i* ./j* ./k* ./l* -type f -exec sed -i 's/e\.g\./for example/g' {} \;
Comment #91
ankitjain28may CreditAttribution: ankitjain28may as a volunteer and at Google Summer of Code commentedComment #92
apadernoAs said in #78, this is not simply a find and replace job. You cannot simply replace i.e. and e.g. with English words; you need to decide how to replace them, and if the punctuation needs to be changed too.
Comment #93
apadernoThe sentence between parentheses is a new sentence. Remove the parentheses and put a comma after for example.
Just remove i.e..
Just remove i.e. any.
Remove bottom i.e..
Remove The plugin configuration, i.e. and accordingly change case to the next word.
(This review is not complete. It gives some examples of why this is not a find/replace task.)
Comment #94
chiranjeeb2410 CreditAttribution: chiranjeeb2410 at Google Summer of Code commented@kiamlaluno,
Addressed #93. Please review.
Comment #95
renatogTank you @chiranjeeb2410. God job.
Just one detail:
Can you make it using limit of comment in 80 chars, please?
Thank you very much
Comment #96
cilefen CreditAttribution: cilefen at Institute for Advanced Study commentedComment #97
Girish-jerk CreditAttribution: Girish-jerk at Valuebound commentedHI @RenatoG,
Have updated the patch by limiting the characters,Please review.
Thanks
Comment #98
renatogPerfect, It likes good for me.
Thank you very much for contributions.
Good Work and Good Weekend.
Best,
Comment #99
cilefen CreditAttribution: cilefen at Institute for Advanced Study commentedThere are IDE files in the patch.
Comment #100
apadernoBe sure you aren't including files Drupal repository doesn't have.
Just use the second part of the sentence: Thrown when no 'destination' query argument is set.
Remove the comma after for example.
Just use the part after i.e.: plugin settings change, to ensure that HTML tags and classes entered here are known to be "required", which may affect filter settings.
The original sentence is a little twisted.
There is no need to make examples of test settings.
(for the theme which being tested is not grammatical.)
Most of the sentences using i.e. I found are just using it as conjunction between two unrelated phrases, such as in this case. The sentence should be Pretend the data was not present in drupalSettings. or Test the separate request to the server.
The sentence, either the original one or the proposed one, doesn't make sense: The author field is not anonymous, but empty; it's the author of the comment to be the anonymous user.
Just take off the parenthetical.
The parenthetical should be before the period. (It would be after the period if it were a sentence, but in that case it should be written as this sentence.)
That is just an example of setting a format appropriate for the field, so it should be introduced by for example.
The original sentence doesn't make sense. (What is an offset comparison?) Just leave out the parenthetical.
This is a correct way to replace e.g.. Still, is there the need to make examples of what a content type is?
The same is true here.
In both the cases, I would use content type.
(I apologize if the review is not complete.)
Comment #101
hi_ten_ja CreditAttribution: hi_ten_ja commentedComment #102
rakesh.gectcr@hiten2112
Thanks for the patch,
Please prvoide an interdiff file. So that the reviewer can review easily.
Please see https://www.drupal.org/documentation/git/interdiff
Comment #103
rakesh.gectcrComment #104
rakesh.gectcrI have removed the IDE files, We still need to address the comments on #100
Comment #105
renatogComment #106
hi_ten_ja CreditAttribution: hi_ten_ja commentedComment #107
renatog@hiten2112
Please create comment limited in 80 chars. (Check this line)
Comment #108
apadernoAlso, let's avoid phrases like that is that this request was. Avoiding to use i.e. doesn't mean always replacing it with the same phrase; it's not a copy-paste work. The appropriate phrase is different for each sentence; sometimes, the sentence needs to be totally rewritten, as I shown.
Comment #109
xjmThese issues need to be postponed until #2714651: Add a rule for replacing e.g. and i.e. with English words is resolved. Thanks!