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/scripts, /core/tests & /core/themes directories
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 |
|---|---|---|---|
| #17 | 2640960-17.patch | 32.62 KB | imalabya |
| #14 | 2640960-replace-ie-eg-with-english-words.patch | 39.59 KB | girish-jerk |
| #5 | 2640960-replace-eg-ie-string.patch | 25.57 KB | imalabya |
| #2 | 2640960-2-fix-string-eg-d8.patch | 46.07 KB | lars toomre |
Comments
Comment #2
lars toomre commentedHere is an initial patch for this round. It covers all of the 'e.g.' strings in core/modules/[l-m]*.
Comment #3
jhodgdonThanks! Mostly great! A few small things to fix...
Please let us not have translatable strings in this patch. It complicates being able to commit these documentation patches to particular versions of Drupal, and these changes are not really bugs per se, enough to invalidate translations for the 160+ languages on localize.drupal.org, just because we don't like "e.g." much.
I am not convinced that this is always an integer or has to be.
If you're going to fix this line... could be fixed even more. Needs additional "the" here and there, and "is" should be "was" I think?
Oops. Stray * on this line from rewrap.
I would not call the parameters "variables" here. I think "parameter" would be better?
Um, what iterator? The one-line doc says this just flattens arrays. ???
We don't want to change translatable strings in this patch.
translatable string change
Comment #4
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 #5
imalabyaThere are 500+ instances of e.g. & i.e.
Have added a patch for core/includes against 8.2.x branch.
Will be adding subsequent patches for other instances.
Comment #6
imalabya@jhodgdon should i change the status to Needs Review for bot test as the patch doesn't cover all the instances
Comment #7
imalabyaIMO the titles of all the related issues should be renamed based on targeting the fix ranges. Like we can use this to fix the changes in core/includes folder.
What are your thoughts @jeniffer?
Comment #8
jhodgdonTake a look at the patch/comment in #2. This issue should be for core/modules/[l-m]* and a separate issue should be made for core/includes.
I agree that the titles should say which files they target. And the issue summaries.
Comment #9
jhodgdonAlso there should be a parent issue with title like:
[meta] Replace i.e. and e.g. with English words
And all of the related issues should be marked as having that one as Parent issue (in their Issue summary and Relationships section).
If you'd like to fix up all the issue titles and make a parent Meta issue, that would be wonderful. Thanks! Right now all you can do is follow Related from round 6 to 5 to 4 etc. They all should have a parent issue.
Comment #10
imalabyaComment #11
imalabyaComment #12
girish-jerk commentedComment #13
jhodgdonI just reviewed a patch made by someone else on a different issue. Please read the comment at #2640718-12: Replace i.e. and e.g. with English words in core/modules A-L before you make a patch here. It may be helpful. Thanks!
Comment #14
girish-jerk commentedHi,
I have created a patch for #11 by replacing i.e. and e.g. with English words.
Comment #15
imalabya#2640718-12: Replace i.e. and e.g. with English words in core/modules A-L is not addressed here.
i.e should be replaced with correct punctuation
which is - "that is,"
same here.
Also I think it should be for example
needs line wrapping
line wrapping and punctuation
punctuation issue here
punctuation issue
Line wrapping
Punctuation issue. Also the documents needs to be rephrased. Not making much sense.
Line wrapping.
Can be written as
"In case a error occurs like fatal,.."
Haven't checked further. The issues are repetitive.
Also please check the documents and read it carefully an replace accordingly. There are instances where writer may have used e.g. but it needs i.e. or vice versa. please check #2640718-12: Replace i.e. and e.g. with English words in core/modules A-L for more information on how to proceed.
Comment #16
jhodgdonClarification: generally the punctuation needs to also have a semicolon in it. Like this:
All of the cats need to be put inside; for example, the red cat and the blue cat.
The cats need to be put inside; that is, they cannot be left outside.
That is the correct punctuation when you are joining two clauses with for example or that is. Sometimes "for example" is also inserted as an aside, like this, and in that case you use a comma not semicolon:
Cats are usually smaller than dogs. Blue cats, for example, weigh just 10 pounds.
Comment #17
imalabyaAdded a new patch.
Comment #18
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 #19
jhodgdonThis series of issues is badly scoped. I am just going to close them. Sorry.