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.

CommentFileSizeAuthor
#107 80chars.png13.46 KBrenatog
#106 23462solve_example_that_is.patch1.7 KBhi_ten_ja
#106 interdiff_23462solve_example_that_is.txt1.7 KBhi_ten_ja
#104 interdiff-2640718-97-104.txt2.46 KBrakesh.gectcr
#104 2640718-104.patch67.12 KBrakesh.gectcr
#103 interdiffff-2640718-94-97.txt5.11 KBrakesh.gectcr
#101 solve_example_that_is.patch906 byteshi_ten_ja
#97 2640718-97.patch67.36 KBGirish-jerk
#95 Img.png23 KBrenatog
#94 2640718-94.patch66.64 KBchiranjeeb2410
#90 replace-with-english-words-2640718-90.patch69.62 KBankitjain28may
#77 interdiff-2640718-75-77.txt8.49 KBchiranjeeb2410
#77 2640718-77.patch185.57 KBchiranjeeb2410
#75 interdiff-2640718-65-75.txt2.11 KBchiranjeeb2410
#75 2640718-75.patch185.33 KBchiranjeeb2410
#73 interdiff-2640718-65-73.txt2.11 KBchiranjeeb2410
#73 2640718-73.patch2.11 KBchiranjeeb2410
#67 2640718-65.patch185.71 KBwelly
#65 interdiff.txt5.27 KBwelly
#65 2640718-64.patch186.53 KBwelly
#63 2640718-63-D8.patch180.47 KBmohit1604
#61 2640718-61-D8.patch182.29 KBmohit1604
#58 2640718-58-D8.patch182.89 KBmohit1604
#52 interdiff.txt1.19 KBmohit1604
#52 2640718-52-D8.patch152.23 KBmohit1604
#50 2640718-50-D8.patch152.79 KBmohit1604
#45 2640718-45_replace_ie_eg.patch71.6 KBZeiP
#43 replace_i_e_and_e_g-2640718-43.patch352.24 KBruthleopold
#38 2640718-38.patch170.57 KBgaurav.kapoor
#34 interdiff.txt5.05 KBboaloysius
#34 replace_ie_eg_with_english_core_module-2640718-34.patch168.48 KBboaloysius
#32 replace_ie_eg_with_english_core_module-2640718-32.patch168.48 KBMunavijayalakshmi
#27 replace_ie_eg_with_english_core_module-2640718-27.patch162.9 KBsaurabh rawat
#26 replace_ie_eg_with_english_core_module-2640718-26.patch160.35 KBsaurabh rawat
#16 interdiff-14-16.diff5.32 KBhimanshugautam
#16 2640718-16.patch29.64 KBhimanshugautam
#14 interdiff-2640718-10-14.txt27.33 KBaditya_anurag
#14 2640718-14.patch29.64 KBaditya_anurag
#10 interdiff-2640718-9-10.txt2.21 KBaditya_anurag
#10 2640718-10.patch31.66 KBaditya_anurag
#9 2640718-9.patch29.92 KBaditya_anurag
#2 2640718-2-fix-string-eg-d8.patch59.81 KBLars Toomre
Support from Acquia helps fund testing for Drupal Acquia logo

Comments

Lars Toomre created an issue. See original summary.

Lars Toomre’s picture

Attached 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*.

Lars Toomre’s picture

Assigned: Lars Toomre » Unassigned
Status: Active » Needs review

Whoops... Forgot to change the status.

jhodgdon’s picture

Status: Needs review » Needs work

Thanks -- mostly looks great! A few small things to fix:

  1. +++ b/core/modules/simpletest/src/BrowserTestBase.php
    @@ -671,15 +672,15 @@ protected function checkPermissions(array $permissions) {
        * user object after logging in, it must be updated manually. If you also need
    -   * access to the plain-text password of the user (set by drupalCreateUser()),
    -   * e.g. to log in the same user again, then it must be re-assigned manually.
    -   * For example:
    +   * access to the plain-text password of the user (set by drupalCreateUser(),
    +   * for instance, to log in the same user again), then it must be re-assigned
    +   * manually. For example:
    

    In the original, the close paren was after "drupalCreateUser()". You've moved it down. I think this was not right.

  2. +++ b/core/modules/simpletest/src/TestDiscovery.php
    @@ -384,13 +386,13 @@ public static function parseTestClassSummary($doc_comment) {
    -   *   - requires: An associative array of @requires values; e.g.:
    +   *   - requires: An associative array of @requires values; for instance,
        *     - module: A list of Drupal module dependencies that are required to
        *       exist.
    

    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?

  3. +++ b/core/modules/simpletest/src/WebTestBase.php
    @@ -576,15 +576,15 @@ protected function drupalCompareFiles($file1, $file2) {
    +   * access to the plain-text password of the user (set by drupalCreateUser(),
    +   * for instance, to log in the same user again), then it must be re-assigned
    

    In the original, the close paren was after "drupalCreateUser()". You've moved it down. I think this was not right.

  4. +++ b/core/modules/simpletest/src/WebTestBase.php
    @@ -1660,13 +1660,13 @@ protected function drupalGetXHR($path, array $options = array(), array $headers
    +   * @param string|null $submit
        *   Value of the submit button whose click is to be emulated. For example,
        *   t('Save'). The processing of the request depends on this value. For
        *   example, a form may have one button with the value t('Save') and another
        *   button with the value t('Delete'), and execute different code depending
        *   on which one is clicked.
    

    Um, really null? What would that mean?

    Really a LOT of this patch, including this bit, is way out of scope for this issue...

  5. +++ b/core/modules/system/src/Plugin/Block/SystemMenuBlock.php
    @@ -189,13 +189,13 @@ public function getCacheTags() {
    +    // Additional cache contexts, for instance, those that determine link text
    +    // or accessibility of a menu, will be bubbled automatically.
    

    I think the "for instance" part here should be in () for clarity. The comma punctuation is not good.

  6. +++ b/core/modules/system/src/Plugin/ImageToolkit/GDToolkit.php
    @@ -33,13 +33,15 @@ class GDToolkit extends ImageToolkitBase {
    +   * Image type represented by a PHP IMAGETYPE_* constant.
    +   *
    +   * This constant, for example, could be IMAGETYPE_JPEG.
    

    How about just:

    PHP image type constant, such as IMAGETYPE_JPEG.

  7. +++ b/core/modules/system/src/Tests/Menu/BreadcrumbTest.php
    @@ -148,15 +148,14 @@ function testBreadCrumbs() {
    -    // Also verify that the node does not appear elsewhere (e.g., menu trees).
    -    $this->assertNoLink($node1->getTitle());
    

    These two lines I think should not have been removed from the test?

  8. +++ b/core/modules/system/tests/modules/image_test/src/Plugin/ImageToolkit/TestToolkit.php
    @@ -31,13 +31,15 @@ class TestToolkit extends ImageToolkitBase {
       /**
    -   * Image type represented by a PHP IMAGETYPE_* constant (e.g. IMAGETYPE_JPEG).
    +   * Image type represented by a PHP IMAGETYPE_* constant.
    +   *
    +   * An example of the image type would be IMAGETYPE_JPEG.
        *
        * @var int
        */
       protected $type;
    

    Actually I think the methods/variables in this class can just use @inheritdoc???

  9. +++ b/core/modules/system/tests/modules/image_test/src/Plugin/ImageToolkit/TestToolkit.php
    @@ -31,13 +31,15 @@ class TestToolkit extends ImageToolkitBase {
    +   * Image type represented by a PHP IMAGETYPE_* constant.
    +   *
    +   * An example of the image type would be IMAGETYPE_JPEG.
    

    Suggestion:

    PHP image type constant, such as IMAGETYPE_JPEG.

jhodgdon’s picture

Also... 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.

imalabya’s picture

imalabya’s picture

Title: Some fixes for 'e.g.' in docblocks and code comments - Round 4 » Replace i.e. and e.g. with English words in core/module A-L
Version: 8.0.x-dev » 8.2.x-dev
Issue summary: View changes
imalabya’s picture

Have 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.

aditya_anurag’s picture

Status: Needs work » Needs review
FileSize
29.92 KB

replaced i.e. with "that is"

aditya_anurag’s picture

Also replaced "e.g" to "for example"

Status: Needs review » Needs work

The last submitted patch, 10: 2640718-10.patch, failed testing.

jhodgdon’s picture

Thanks for the patches! I think the test failure is not related to this patch.

However, this patch needs some work:

+++ b/core/modules/big_pipe/src/Controller/BigPipeController.php
@@ -33,8 +33,8 @@ class BigPipeController {
+   *   Thrown when the original location is missing, that is when no
+   *   'destination' query argument is set.

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!

aditya_anurag’s picture

Assigned: Unassigned » aditya_anurag

Thanks for Suggestion. I will work on the suggested change.

aditya_anurag’s picture

Assigned: aditya_anurag » Unassigned
Status: Needs work » Needs review
FileSize
29.64 KB
27.33 KB
imalabya’s picture

Status: Needs review » Needs work
  1. +++ b/core/modules/big_pipe/src/Render/BigPipeInterface.php
    @@ -111,8 +111,8 @@
    + *     Responses, that is, any footer/bottom/non-header JavaScript, is loaded
    

    "such as" is more suitable here. thoughts?

  2. +++ b/core/modules/big_pipe/src/Render/BigPipeInterface.php
    @@ -124,7 +124,7 @@
    + *  8. Send script_bottom (markup to load bottom that is, non-critical JS).
    

    need to rephrase, not making much sense.

  3. +++ b/core/modules/block/tests/modules/block_test/src/Plugin/Block/TestAccessBlock.php
    @@ -30,9 +30,9 @@ class TestAccessBlock extends BlockBase implements ContainerFactoryPluginInterfa
    +   *   The plugin configuration, that is, an array with configuration values
    

    "which is" suits better

  4. +++ b/core/modules/ckeditor/src/CKEditorPluginManager.php
    @@ -57,7 +57,7 @@ public function __construct(\Traversable $namespaces, CacheBackendInterface $cac
    +   * even implicitly loaded (that is, internal) plugins, then set the optional
    

    "(that is, internal) plugins" -> even implicitly loaded plugin, which are internal plugins,..

  5. +++ b/core/modules/color/src/Tests/ColorTest.php
    @@ -101,8 +101,8 @@ function testColor() {
    +   *   An associative array of test settings (for example, 'Main background',
    +   * 'Text color', 'Color set', etc) for the theme which being tested.
    

    same here as above. Also need one more space in the second line.

  6. +++ b/core/modules/comment/src/Tests/CommentInterfaceTest.php
    @@ -252,10 +252,10 @@ public function testAutoFilledSubject() {
    +    // Set up two default (that is, filtered HTML) input formats, because
    

    it says "Set up two default input format" but one is written.

  7. +++ b/core/modules/contextual/js/toolbar/views/VisualView.js
    @@ -63,7 +63,7 @@
    +     * it's not the default value (that is, false).
    

    false need to be FALSE

  8. +++ b/core/modules/editor/js/editor.admin.js
    @@ -157,8 +157,8 @@
    +              // property rule. that is, will become true if >=1 filter rule
    

    this needs to be replaced with "For example"

  9. +++ b/core/modules/editor/js/editor.admin.js
    @@ -655,16 +655,16 @@
    +   * `<table>` tag, and might allow for example, the "summary" attribute on that
    

    needs a comma before "for example" and after attribute

  10. +++ b/core/modules/filter/src/Plugin/Filter/FilterAutoP.php
    @@ -15,7 +15,7 @@
    + *   title = @Translation("Convert line breaks into HTML (that is, <code>&lt;br&gt;

    and &lt;p&gt;)"),

    Annotations are not a part of the scope.

  11. +++ b/core/modules/locale/locale.compare.inc
    @@ -132,7 +132,7 @@ function locale_translation_project_list() {
    + *   The project type. that is, module, theme.
    

    "like" or "such as" suits better IMO

himanshugautam’s picture

changes made as per comment #15

himanshugautam’s picture

Status: Needs work » Needs review

Status: Needs review » Needs work

The last submitted patch, 16: interdiff-14-16.diff, failed testing.

jhodgdon’s picture

Status: Needs work » Needs review

We usually name the interdiff files with a .txt extension so that they don't get tested as patches. ;)

jhodgdon’s picture

On #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.

Version: 8.2.x-dev » 8.3.x-dev

Drupal 8.2.0-beta1 was released on August 3, 2016, which means new developments and disruptive changes should now be targeted against the 8.3.x-dev branch. For more information see the Drupal 8 minor version schedule and the Allowed changes during the Drupal 8 release cycle.

Version: 8.3.x-dev » 8.4.x-dev

Drupal 8.3.0-alpha1 will be released the week of January 30, 2017, which means new developments and disruptive changes should now be targeted against the 8.4.x-dev branch. For more information see the Drupal 8 minor version schedule and the Allowed changes during the Drupal 8 release cycle.

Munavijayalakshmi’s picture

Assigned: Unassigned » Munavijayalakshmi
Status: Needs review » Needs work
  1. +++ b/core/modules/ckeditor/src/CKEditorPluginManager.php
    @@ -57,7 +57,7 @@ public function __construct(\Traversable $namespaces, CacheBackendInterface $cac
    +   * even implicitly loaded plugin, which are internal plugins, then set the optional
    

    Line exceeding 80 characters

  2. +++ b/core/modules/comment/src/Tests/CommentInterfaceTest.php
    @@ -252,10 +252,10 @@ public function testAutoFilledSubject() {
    +    // Set up two default input formats which are FullHTML and FilteredHTML, because
    

    Line exceeding 80 characters

  3. +++ b/core/modules/editor/js/editor.admin.js
    @@ -157,8 +157,8 @@
    +              // property rule.For example it will become true if >=1, filter rule
    

    Line exceeding 80 characters

  4. +++ b/core/modules/editor/js/editor.admin.js
    @@ -655,16 +655,16 @@
    +   * `<table>`, tag, and might allow, for example, the "summary" attribute on that
    

    Line exceeding 80 characters

Munavijayalakshmi’s picture

Assigned: Munavijayalakshmi » Unassigned
himanshu-dixit’s picture

Status: Needs work » Needs review

.

saurabh rawat’s picture

saurabh rawat’s picture

dhruveshdtripathi’s picture

Status: Needs review » Needs work

Getting warnings after applying patch #27.

warning: squelched 14 whitespace errors
warning: 19 lines add whitespace errors.

tameeshb’s picture

Multiple comments in #27 exceed the 80 character limit.

himanshu-dixit’s picture

Priority: Normal » Minor
Issue tags: +Novice, +php-novice
himanshu-dixit’s picture

Issue tags: -php-novice
Munavijayalakshmi’s picture

Fixed #28 and #29.

darius.restivan’s picture

Some of the "e.g"s were replaced at the beginning of a sentance with "for example", where the F should be a capital letter.

boaloysius’s picture

Status: Needs review » Needs work

The last submitted patch, 34: replace_ie_eg_with_english_core_module-2640718-34.patch, failed testing.

boaloysius’s picture

Issue tags: +Needs reroll
gaurav.kapoor’s picture

Assigned: Unassigned » gaurav.kapoor
gaurav.kapoor’s picture

Assigned: gaurav.kapoor » Unassigned
Status: Needs work » Needs review
FileSize
170.57 KB
gaurav.kapoor’s picture

This much should be reviewed and fixed quickly or else we will end up creating new patch again and again.

jofitz’s picture

Issue tags: -Needs reroll

Removed Needs Reroll tag.

boaloysius’s picture

seancgraham’s picture

We (me and ghostinthemachines) are working on testing this (Drupal Con novice sprinters). We are having trouble applying the patch. Hunk #1 Failed at 59.

ruthleopold’s picture

I tried to apply this patch, it didn't work so I rerolled it.

Status: Needs review » Needs work

The last submitted patch, 43: replace_i_e_and_e_g-2640718-43.patch, failed testing. View results
- codesniffer_fixes.patch Interdiff of automated coding standards fixes only.

ZeiP’s picture

Category: Bug report » Task
FileSize
71.6 KB

The 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.

Version: 8.4.x-dev » 8.5.x-dev

Drupal 8.4.0-alpha1 will be released the week of July 31, 2017, which means new developments and disruptive changes should now be targeted against the 8.5.x-dev branch. For more information see the Drupal 8 minor version schedule and the Allowed changes during the Drupal 8 release cycle.

MaskyS’s picture

Assigned: Unassigned » MaskyS
Issue tags: +Needs reroll

Taking this one ;)

Version: 8.5.x-dev » 8.6.x-dev

Drupal 8.5.0-alpha1 will be released the week of January 17, 2018, which means new developments and disruptive changes should now be targeted against the 8.6.x-dev branch. For more information see the Drupal 8 minor version schedule and the Allowed changes during the Drupal 8 release cycle.

mohit1604’s picture

Assigned: MaskyS » mohit1604
mohit1604’s picture

Assigned: mohit1604 » Unassigned
Status: Needs work » Needs review
FileSize
152.79 KB

Patch for 8.6.x , Thanks :)

Status: Needs review » Needs work

The last submitted patch, 50: 2640718-50-D8.patch, failed testing. View results

mohit1604’s picture

Status: Needs work » Needs review
FileSize
152.23 KB
1.19 KB

Interdiff of patch #50 and #52 .

jofitz’s picture

Issue tags: -Needs reroll
Michelle-Buckby’s picture

Working on this issue, reviewing how the patch works from comment #52.

recluso’s picture

Status: Needs review » Needs work

Patch applied successfully, but there are white space warnings.

Admins-MacBook-Pro-2:drupal sacha$ git apply -v 2640718-52-D8.patch
2640718-52-D8.patch:63: tab in indent.
	// 3) For body or html element, that is in case of the html node
2640718-52-D8.patch:64: tab in indent.
	// - it will return itself

Lines 63 and 64 are in jquery.js. As in third party file do not know what to do.

recluso’s picture

Issue tags: +Needs reroll

Needs reroll

Checking patch core/includes/install.inc...
Hunk #1 succeeded at 778 (offset 9 lines).

Checking patch core/scripts/drupal.sh...
Hunk #1 succeeded at 36 (offset 2 lines).
Checking patch core/scripts/run-tests.sh...
Hunk #1 succeeded at 267 (offset 1 line).
Hunk #2 succeeded at 534 (offset 1 line).
mohit1604’s picture

Assigned: Unassigned » mohit1604
mohit1604’s picture

Status: Needs work » Needs review
FileSize
182.89 KB

Fixing warnings and error as per comment #55 and #56 , Please review it , Thank you :)

mohit1604’s picture

Assigned: mohit1604 » Unassigned

Status: Needs review » Needs work

The last submitted patch, 58: 2640718-58-D8.patch, failed testing. View results

mohit1604’s picture

Status: Needs work » Needs review
FileSize
182.29 KB

Status: Needs review » Needs work

The last submitted patch, 61: 2640718-61-D8.patch, failed testing. View results

mohit1604’s picture

Status: Needs work » Needs review
FileSize
180.47 KB
andrewmacpherson’s picture

Issue tags: +SprintWeekend2018

First-time contributors worked on this at a sprint workshop in Leeds UK

welly’s picture

Patch applied correctly but found some missing/additional i.e. and e.g. Have updated the patch, and added an interdiff.

Status: Needs review » Needs work

The last submitted patch, 65: 2640718-64.patch, failed testing. View results

welly’s picture

Cleaned up patch

welly’s picture

Status: Needs work » Needs review
bhanuprakashnani’s picture

Status: Needs review » Reviewed & tested by the community

Patch applies cleanly. Changes made are sufficient.

cilefen’s picture

Status: Reviewed & tested by the community » Needs work
  1. +++ b/core/assets/vendor/jquery/jquery.js
    @@ -10042,7 +10043,7 @@ jQuery.fn.extend( {
    -	// 3) For body or html element, i.e. in case of the html node - it will return itself
    +  // 3) For body or html element, that is in case of the html node - it will return itself
    

    What's the deal with indentations changing?

  2. +++ b/core/core.api.php
    @@ -525,7 +525,7 @@
    - *   absolutely necessary. (i.e. maximizing the cache hit ratio.)
    + *   absolutely necessary. (that is maximizing the cache hit ratio.)
    

    This does not make sense.

  3. +++ b/core/core.api.php
    @@ -2234,7 +2234,7 @@ function hook_cache_flush() {
    - * i.e., all previously cached data is known to be gone and every API in the
    + * that is, all previously cached data is known to be gone and every API in the
    

    This is not clear. "In other words" would perhaps make more sense here.

  4. +++ b/core/includes/common.inc
    @@ -407,7 +407,7 @@ function drupal_set_time_limit($time_limit) {
    - * Returns the base URL path (i.e., directory) of the Drupal installation.
    + * Returns the base URL path (that is, directory) of the Drupal installation.
    

    Try "(the directory)" or "(that is, the directory)".

  5. +++ b/core/includes/entity.inc
    @@ -225,7 +225,7 @@ function entity_load_multiple_by_properties($entity_type, array $values) {
    - * Loads the unchanged, i.e. not modified, entity from the database.
    + * Loads the unchanged, that is not modified, entity from the database.
    

    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!

Mayuresh7’s picture

Assigned: Unassigned » Mayuresh7

I am working on it.

apaderno’s picture

I 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.

Returns the base URL path (the directory) of the Drupal installation.

chiranjeeb2410’s picture

Status: Needs work » Needs review
FileSize
2.11 KB
2.11 KB

@cilefen,

Addressed issues 2,3,4 & 5 as suggested. Also, attached interdiff alongwith patch.
Please review.

Status: Needs review » Needs work

The last submitted patch, 73: 2640718-73.patch, failed testing. View results

chiranjeeb2410’s picture

Status: Needs work » Needs review
FileSize
185.33 KB
2.11 KB

Attached correct patch. Hope it shows green.
Please review.

apaderno’s picture

Status: Needs review » Needs work
-			// Apply set filters to unmatched elements
-			// NOTE: This can be skipped if there are no unmatched elements (i.e., `matchedCount`
-			// equals `i`), unless we didn't visit _any_ elements in the above loop because we have
-			// no element matchers and no seed.
-			// Incrementing an initially-string "0" `i` allows `i` to remain a string only in that
-			// case, which will result in a "00" `matchedCount` that differs from `i` but is also
-			// numerically zero.
+// Apply set filters to unmatched elements.
+// NOTE: This can be skipped if there are no unmatched elements
+// (that is, `matchedCount` equals `i`), unless we didn't visit
+// _any_ elements in the above loop because we have no element
+// matchers and no seed. Incrementing an initially-string "0" `i`
+// allows `i` to remain a string only in that case, which will
+// result in a "00" `matchedCount` that differs from `i` but is
+//also numerically zero.

The indentation is still changed.

  * This hook is only invoked after the system has been completely cleared;
- * i.e., all previously cached data is known to be gone and every API in the
+ * In other words, all previously cached data is known to be gone and every API in the

The previous sentence ends with a semicolon, so the next one doesn't need to start with a capital letter.

- * Loads the unchanged, i.e. not modified, entity from the database.
+ * Loads the unchanged, i.e. the not modified entity from the database.

Also, in this case i.e. is not necessary. Just use a parenthetical.

Loads the unchanged (not modified) entity from the database.

- * - "managed files", i.e. those stored by a Drupal-compatible stream wrapper.
+ * - "managed files", that is those stored by a Drupal-compatible stream wrapper.
  *   These are files that have either been uploaded by users or were generated
  *   automatically (for example through CSS aggregation).
- * - "shipped files", i.e. those outside of the files directory, which ship as
+ * - "shipped files", that is those outside of the files directory, which ship as
  *   part of Drupal core or contributed modules or themes.

Also, there is no need to use that is either.

- "managed files", those stored by a Drupal-compatible stream wrapper.
- "shipped files", those outside of the files directory, which ship as part of Drupal core or contributed modules or themes.

- * digits of the file permission (i.e. user, group and all).
+ * digits of the file permission (that is user, group and all).

In this case, i.e. is fine, since it is followed from an exhaustive list. In American English, Oxford comma is used.

digits of the file permission (i.e. user, group, and other users).

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.

digits of the UNIX file permissions.

  *   (optional) The base file name (without the $type extension). If omitted,
- *   $module is used; i.e., resulting in "$module.$type" by default.
+ *   $module is used; that is, resulting in "$module.$type" by default.

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..

(optional) The base file name (without the $type extension). If omitted, $module is used, resulting in "$module.$type" being used by default.

- * width devices and shown on medium+ width devices (i.e. tablets and desktops).
+ * width devices and shown on medium+ width devices (that is tablets and desktops).

In this case, the use of i.e. is correct because follows an exhaustive list. It is also not necessary.

width devices and shown on medium+ width devices (tablets and desktops).

- * and medium viewports and shown on wide devices (i.e. desktops).
+ * and medium viewports and shown on wide devices (that is desktops).

Just use (desktops).

  * tags) that contain the links. This is necessary for CSS to be able to style
  * list items differently when the link is active, since CSS does not yet allow
  * one to style list items only if it contains a certain element with a certain
- * class. I.e. we cannot yet convert this jQuery selector to a CSS selector:
+ * class. that is we cannot yet convert this jQuery selector to a CSS selector:
  * jQuery('li:has("a.is-active")')

Just remove I.e. and capitalize the next word.

This is necessary for CSS to be able to style list items differently when the link is active, since CSS does not yet allow one to style list items only if it contains a certain element with a certain class. We cannot yet convert this jQuery selector to a CSS selector:

As alternative, I would use the following.

This is necessary for CSS to be able to style list items differently when the link is active, since CSS does not yet allow one to style list items only if it contains a certain element with a certain class, which means we cannot yet convert this jQuery selector to a CSS selector:

  * The function takes into account standard dependencies within each module, as
- * shown above (i.e., the fact that each module's updates must run in numerical
+ * shown above (that is, the fact that each module's updates must run in numerical
  * order), but also finds any cross-module dependencies that are defined by
  * modules which implement hook_update_dependencies(), and builds them into the
  * graph as well.

Let's go straight to the point, instead of using an "abstract" phrase that needs to be explained.

The function takes into account the fact that each module's updates must run in numerical, but also finds any cross-module dependencies that are defined by modules which implement hook_update_dependencies(), and builds them into the graph as well.

-    // Assign new component for each new vertex, i.e. when not called recursively.
+    // Assign new component for each new vertex, that is when not called recursively.

That is a perfect example of when not use i.e. Just remove it.

-    // atomically, i.e. there is no point at which another process attempting to
+    // atomically, that is there is no point at which another process attempting to

Replace it with which means.

(I apologize this review is not complete.)

chiranjeeb2410’s picture

Assigned: Mayuresh7 » Unassigned
Status: Needs work » Needs review
FileSize
185.57 KB
8.49 KB

@kiamlaluno,

Uploaded patch contains all above-mentioned changes. Please review accordingly.
Hope to show greem.

cilefen’s picture

Status: Needs review » Needs work
  1. +++ b/core/assets/vendor/ckeditor/CHANGES.md
    @@ -906,7 +906,7 @@ Other Changes:
    -* The default class of captioned images has changed to `image` (was: `caption`). Please note that once edited in CKEditor 4.4+, all existing images of the `caption` class (`<figure class="caption">`) will be [filtered out](https://docs.ckeditor.com/ckeditor4/docs/#!/guide/dev_advanced_content_filter) unless the [`config.image2_captionedClass`](https://docs.ckeditor.com/ckeditor4/docs/#!/api/CKEDITOR.config-cfg-image2_captionedClass) option is set to `caption`. For backward compatibility (i.e. when upgrading), it is highly recommended to use this setting, which also helps prevent CSS conflicts, etc. This does not apply to new CKEditor integrations.
    +* The default class of captioned images has changed to `image` (was: `caption`). Please note that once edited in CKEditor 4.4+, all existing images of the `caption` class (`<figure class="caption">`) will be [filtered out](http://docs.ckeditor.com/#!/guide/dev_advanced_content_filter) unless the [`config.image2_captionedClass`](http://docs.ckeditor.com/#!/api/CKEDITOR.config-cfg-image2_captionedClass) option is set to `caption`. For backward compatibility (that is when upgrading), it is highly recommended to use this setting, which also helps prevent CSS conflicts, etc. This does not apply to new CKEditor integrations.
    

    We do not manage file contents in core/assets/vendor.

  2. +++ b/core/themes/seven/css/components/quickedit.css
    @@ -2,7 +2,7 @@
    - * I.e. loaded by Quick Edit on the front-end, despite this being a back-end theme.
    + * that is loaded by Quick Edit on the front-end, despite this being a back-end theme.
    

    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.

cilefen’s picture

Also, 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.

apaderno’s picture

That 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.

apaderno’s picture

For example, in the following sentence, i.e. should not be even used.

Hence updating the mtime here is comparable to pointing a symbolic link at a new target, i.e., the newly created file.

Removing it requires to require the phrase, though.

Hence, updating the mtime here is comparable to pointing the symbolic link to the newly created file.

savkaviktor16@gmail.com’s picture

Issue tags: -Needs reroll

the patch applies cleanly

apaderno’s picture

I understand there are three different patches, but there should be changes that are applied equally to all of them.

apaderno’s picture

Title: Replace i.e. and e.g. with English words in core/module A-L » Replace i.e. and e.g. with English words in core/modules A-L

Actually, 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.

  • core/modules/action
  • core/modules/aggregator
  • core/modules/automated_cron
  • core/modules/ban
  • core/modules/basic_auth
  • core/modules/big_pipe
  • core/modules/block
  • core/modules/block_content
  • core/modules/block_place
  • core/modules/book
  • core/modules/breakpoint
  • core/modules/ckeditor
  • core/modules/color
  • core/modules/comment
  • core/modules/config
  • core/modules/config_translation
  • core/modules/contact
  • core/modules/content_moderation
  • core/modules/content_translation
  • core/modules/contextual
  • core/modules/datetime
  • core/modules/datetime_range
  • core/modules/dblog
  • core/modules/dynamic_page_cache
  • core/modules/editor
  • core/modules/entity_reference
  • core/modules/field
  • core/modules/field_layout
  • core/modules/field_ui
  • core/modules/file
  • core/modules/filter
  • core/modules/forum
  • core/modules/hal
  • core/modules/help
  • core/modules/history
  • core/modules/image
  • core/modules/inline_form_errors
  • core/modules/language
  • core/modules/layout_builder
  • core/modules/layout_discovery
  • core/modules/link
  • core/modules/locale
chiranjeeb2410’s picture

@kiamlaluno,

That's a lot of files to handle though.

cilefen’s picture

Thus what I wrote in #79.

apaderno’s picture

@chiranjeeb2410 Three issues have been created to replace i.e. and e.g. and each of them handles a specific set of files.

apaderno’s picture

@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.

hi_ten_ja’s picture

Is it easiet issueto solve?

ankitjain28may’s picture

I 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' {} \;

ankitjain28may’s picture

Status: Needs work » Needs review
apaderno’s picture

Status: Needs review » Needs work

As 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.

apaderno’s picture

-   * provide the field labels on a best-effort basis (e.g. the label of a field
+   * provide the field labels on a best-effort basis (for example the label of a field
    * storage without any field attached to a bundle will be the field name).

The sentence between parentheses is a new sentence. Remove the parentheses and put a comma after for example.

-    // Run after HtmlResponsePlaceholderStrategySubscriber (priority 5), i.e.
+    // Run after HtmlResponsePlaceholderStrategySubscriber (priority 5), that is
     // after BigPipeStrategy has been applied, but before normal (priority 0)

Just remove i.e..

  *   - Finally: any non-critical JavaScript associated with all Embedded HTML
- *     Responses, i.e. any footer/bottom/non-header JavaScript, is loaded after
+ *     Responses, that is any footer/bottom/non-header JavaScript, is loaded after

Just remove i.e. any.

- *  8. Send script_bottom (markup to load bottom i.e. non-critical JS).
+ *  8. Send script_bottom (markup to load bottom that is non-critical JS).

Remove bottom i.e..

-   *   The plugin configuration, i.e. an array with configuration values keyed
+   *   The plugin configuration, that is an array with configuration values keyed

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.)

chiranjeeb2410’s picture

Status: Needs work » Needs review
FileSize
66.64 KB

@kiamlaluno,

Addressed #93. Please review.

renatog’s picture

Status: Needs review » Needs work
FileSize
23 KB

Tank you @chiranjeeb2410. God job.

Just one detail:

Can you make it using limit of comment in 80 chars, please?

Thank you very much

cilefen’s picture

Girish-jerk’s picture

Status: Needs work » Needs review
FileSize
67.36 KB

HI @RenatoG,

Have updated the patch by limiting the characters,Please review.

Thanks

renatog’s picture

Status: Needs review » Reviewed & tested by the community

Perfect, It likes good for me.

Thank you very much for contributions.

Good Work and Good Weekend.

Best,

cilefen’s picture

Status: Reviewed & tested by the community » Needs work

There are IDE files in the patch.

apaderno’s picture

diff --git a/.idea/php.xml b/.idea/php.xml
new file mode 100644
index 0000000..10b171f
--- /dev/null
+++ b/.idea/php.xml
@@ -0,0 +1,4 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<project version="4">
+  <component name="PhpProjectSharedConfiguration" php_language_level="7.1" />
+</project>
\ No newline at end of file
diff --git a/.idea/vcs.xml b/.idea/vcs.xml
new file mode 100644
index 0000000..94a25f7
--- /dev/null
+++ b/.idea/vcs.xml
@@ -0,0 +1,6 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<project version="4">
+  <component name="VcsDirectoryMappings">
+    <mapping directory="$PROJECT_DIR$" vcs="Git" />
+  </component>
+</project>
\ No newline at end of file

Be sure you aren't including files Drupal repository doesn't have.

-   *   Thrown when the original location is missing, i.e. when no 'destination'
+   *   Thrown when the original location is missing, that is when no 'destination'

Just use the second part of the sentence: Thrown when no 'destination' query argument is set.

-   *   The operation to perform, e.g., 'enable' or 'disable'.
+   *   The operation to perform, for example, 'enable' or 'disable'.

Remove the comma after for example.

    * Triggers the CKEditorPluginSettingsChanged event whenever the "stylescombo"
    * plugin settings change, to ensure that the corresponding feature metadata
-   * is immediately updated — i.e. ensure that HTML tags and classes entered
+   * is immediately updated — that is ensure that HTML tags and classes entered
    * here are known to be "required", which may affect filter settings.
    *

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.

    * Internal plugins (those that are part of the bundled build of CKEditor) are
    * excluded by default, since they are loaded implicitly. If you need to know
-   * even implicitly loaded (i.e. internal) plugins, then set the optional
+   * even implicitly loaded (that is internal) plugins, then set the optional
    * second parameter.

The original sentence is a little twisted.

Internal plugins (which are part of the bundled build of CKEditor) are excluded by default, since they are implicitly loaded. If you need to get also those plugins, set the optional second parameter.

 /**
- * Defines the "internal" plugin (i.e. core plugins part of our CKEditor build).
+ * Defines the "internal" plugin (that is core plugins part of our CKEditor build).
  *
Defines the "internal" plugins, core plugins part of our CKEditor build.
-   *   An associative array of test settings (i.e. 'Main background', 'Text
+   *   An associative array of test settings (that is 'Main background', 'Text
    *   color', 'Color set', etc) for the theme which being tested.

There is no need to make examples of test settings.

An associative array of test settings for the tested theme.

(for the theme which being tested is not grammatical.)

-    // Pretend the data was not present in drupalSettings, i.e. test the
+    // Pretend the data was not present in drupalSettings, that is test the
     // separate request to the server.

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.

-    $this->assertFieldByName('uid', '', 'The author field is empty (i.e. anonymous) when editing the comment.');
+    $this->assertFieldByName('uid', '', 'The author field is empty (that is anonymous) when editing the comment.');

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.

-      '#description' => $this->t('Enter the name of the configuration file without the <em>.yml</em> extension. (e.g. <em>system.site</em>)'),
+      '#description' => $this->t('Enter the name of the configuration file without the <em>.yml</em> extension. (for example <em>system.site</em>)'),

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.)

-      '#description' => t("Choose a format for displaying the date. Be sure to set a format appropriate for the field, i.e. omitting time for a field that only has a date."),
+      '#description' => t("Choose a format for displaying the date. Be sure to set a format appropriate for the field, that is omitting time for a field that only has a date."),

That is just an example of setting a format appropriate for the field, so it should be introduced by for example.

-    // with them. For relative (i.e. 'offset') comparisons, we need to compute
+    // with them. For relative (that is 'offset') comparisons, we need to compute

The original sentence doesn't make sense. (What is an offset comparison?) Just leave out the parenthetical.

    * @param string $type
-   *   A node type (e.g., 'article', 'page' or 'forum').
+   *   A node type (for example, 'article', 'page' or 'forum').

This is a correct way to replace e.g.. Still, is there the need to make examples of what a content type is?

    * @param string $type
-   *   Node content type (e.g., 'article').
+   *   Node content type (for example, 'article').

The same is true here.
In both the cases, I would use content type.

(I apologize if the review is not complete.)

hi_ten_ja’s picture

rakesh.gectcr’s picture

@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

rakesh.gectcr’s picture

rakesh.gectcr’s picture

I have removed the IDE files, We still need to address the comments on #100

renatog’s picture

Status: Needs work » Needs review
hi_ten_ja’s picture

renatog’s picture

Status: Needs review » Needs work
FileSize
13.46 KB

@hiten2112

Please create comment limited in 80 chars. (Check this line)

apaderno’s picture

Also, 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.

xjm’s picture

Status: Needs work » Postponed
Issue tags: -Novice

These issues need to be postponed until #2714651: Add a rule for replacing e.g. and i.e. with English words is resolved. Thanks!

Version: 8.6.x-dev » 8.7.x-dev

Drupal 8.6.0-alpha1 will be released the week of July 16, 2018, which means new developments and disruptive changes should now be targeted against the 8.7.x-dev branch. For more information see the Drupal 8 minor version schedule and the Allowed changes during the Drupal 8 release cycle.

Version: 8.7.x-dev » 8.8.x-dev

Drupal 8.7.0-alpha1 will be released the week of March 11, 2019, which means new developments and disruptive changes should now be targeted against the 8.8.x-dev branch. For more information see the Drupal 8 minor version schedule and the Allowed changes during the Drupal 8 release cycle.

Version: 8.8.x-dev » 8.9.x-dev

Drupal 8.8.0-alpha1 will be released the week of October 14th, 2019, which means new developments and disruptive changes should now be targeted against the 8.9.x-dev branch. (Any changes to 8.9.x will also be committed to 9.0.x in preparation for Drupal 9’s release, but some changes like significant feature additions will be deferred to 9.1.x.). For more information see the Drupal 8 and 9 minor version schedule and the Allowed changes during the Drupal 8 and 9 release cycles.

Version: 8.9.x-dev » 9.1.x-dev

Drupal 8.9.0-beta1 was released on March 20, 2020. 8.9.x is the final, long-term support (LTS) minor release of Drupal 8, which means new developments and disruptive changes should now be targeted against the 9.1.x-dev branch. For more information see the Drupal 8 and 9 minor version schedule and the Allowed changes during the Drupal 8 and 9 release cycles.

Version: 9.1.x-dev » 9.2.x-dev

Drupal 9.1.0-alpha1 will be released the week of October 19, 2020, which means new developments and disruptive changes should now be targeted for the 9.2.x-dev branch. For more information see the Drupal 9 minor version schedule and the Allowed changes during the Drupal 9 release cycle.

Version: 9.2.x-dev » 9.3.x-dev

Drupal 9.2.0-alpha1 will be released the week of May 3, 2021, which means new developments and disruptive changes should now be targeted for the 9.3.x-dev branch. For more information see the Drupal core minor version schedule and the Allowed changes during the Drupal core release cycle.

Version: 9.3.x-dev » 9.4.x-dev

Drupal 9.3.0-rc1 was released on November 26, 2021, which means new developments and disruptive changes should now be targeted for the 9.4.x-dev branch. For more information see the Drupal core minor version schedule and the Allowed changes during the Drupal core release cycle.

Version: 9.4.x-dev » 9.5.x-dev

Drupal 9.4.0-alpha1 was released on May 6, 2022, which means new developments and disruptive changes should now be targeted for the 9.5.x-dev branch. For more information see the Drupal core minor version schedule and the Allowed changes during the Drupal core release cycle.

Version: 9.5.x-dev » 10.1.x-dev

Drupal 9.5.0-beta2 and Drupal 10.0.0-beta2 were released on September 29, 2022, which means new developments and disruptive changes should now be targeted for the 10.1.x-dev branch. For more information see the Drupal core minor version schedule and the Allowed changes during the Drupal core release cycle.

Version: 10.1.x-dev » 11.x-dev

Drupal core is moving towards using a “main” branch. As an interim step, a new 11.x branch has been opened, as Drupal.org infrastructure cannot currently fully support a branch named main. New developments and disruptive changes should now be targeted for the 11.x branch, which currently accepts only minor-version allowed changes. For more information, see the Drupal core minor version schedule and the Allowed changes during the Drupal core release cycle.