Replace i.e. and e.g. with English words in core/modules N-V

Mostly looks great! A few small things to fix...

1. +++ b/core/modules/node/src/Cache/NodeAccessGrantsCacheContext.php
   @@ -12,13 +12,13 @@
   + * Calculated cache context ID: 'user.node_grants:%operation', for example,
   

   Before for example, there should be a ; not ,

2. +++ b/core/modules/quickedit/js/quickedit.js
   @@ -529,17 +529,17 @@
   +   *       (for example, 0, 1 or n, depending on whether it is the first,
   

   should have a comma before "or"

3. +++ b/core/modules/rdf/rdf.info.yml
   @@ -1,6 +1,6 @@
   +description: 'Enriches your content with metadata to let other applications (for example, search engines or aggregators) better understand its relationships and attributes.'
   

   Module descriptions are translatable strings. Let's leave this out of the patch.

4. +++ b/core/modules/rdf/rdf.module
   @@ -13,13 +13,13 @@
   +      $output .= '<p>' . t('The RDF module enriches your content with metadata to let other applications (for example, search engines or aggregators) better understand its relationships and attributes. This semantically enriched, machine-readable output for your website uses the <a href=":rdfa">RDFa specification</a>, which allows RDF data to be embedded in HTML markup. Other modules can define mappings of their data to RDF terms, and the RDF module makes this RDF data available to the theme. The core modules define RDF mappings for their data model, and the core themes output this RDF metadata information along with the human-readable visual information. For more information, see the <a href=":rdf">online documentation for the RDF module</a>.', array(':rdfa' => 'http://www.w3.org/TR/xhtml-rdfa-primer/', ':rdf' => 'https://www.drupal.org/documentation/modules/rdf')) . '</p>';
   

   Translatable string, leave out of patch.

5. +++ b/core/modules/rdf/rdf.module
   @@ -293,23 +293,23 @@ function _rdf_set_field_rel_attribute(&$variables) {
   -  // the view mode (e.g. full vs. teaser).
   +  // the view mode (for example, full vis-a-vis teaser).
   

   vs. is not an abbreviation for "vis-a-vis", but "versus".

6. +++ b/core/modules/responsive_image/responsive_image.module
   @@ -36,13 +36,13 @@ function responsive_image_help($route_name, RouteMatchInterface $route_match) {
   +      $output .= '<dd>' . t('Once the sizes option is selected, you can let the browser know the size of this image in relation to the site layout, using the <em>Sizes</em> field. For a hero image that always fills the entire screen, you could simply enter 100vw, which means 100% of the viewport width. For an image that fills 90% of the screen for small viewports, but only fills 40% of the screen when the viewport is larger than 40em (typically 640px), you could enter "(min-width: 40em) 40vw, 90vw" in the Sizes field. The last item in the comma-separated list is the smallest viewport size: other items in the comma-separated list should have a media condition paired with an image width. <em>Media conditions</em> are similar to a media query, often a min-width paired with a viewport width using em or px units: for example, (min-width: 640px) or (min-width: 40em). This is paired with the <em>image width</em> at that viewport size using px, em or vw units. The vw unit is viewport width and is used instead of a percentage because the percentage always refers to the width of the entire viewport.</dd>');
   

   Let's not have translatable strings in the patch.

7. +++ b/core/modules/rest/src/Tests/RESTTestBase.php
   @@ -298,13 +300,13 @@ protected function curlExec($curl_options, $redirect = FALSE) {
   +   *   The operation; one of 'view', 'create', 'update' or 'delete'.
   

   needs comma before "or"

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.

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.

I just reviewed a patch made by someone 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!

The patch resulted in a huge size of 125kb :(

Do we need to break it up more?

I think the patch size is OK. it is a bit large but the changes are fairly straightforward.

Needs a bit of work though:

1. +++ b/core/modules/node/src/Tests/NodeTestBase.php
   @@ -53,9 +53,9 @@ protected function setUp() {
   +   *   and account, with each key as the name of an operation (for exmaple,
   

   example is misspelled here.

2. +++ b/core/modules/options/src/Plugin/Field/FieldType/ListFloatItem.php
   @@ -16,7 +16,7 @@
   + *   description = @Translation("This field stores float values from a list of allowed 'value => label' pairs; for example, 'Fraction': 0 => 0, .25 => 1/4, .75 => 3/4, 1 => 1."),
   

   This is translated text and not API docs or comments. So, we should put this change in a separate issue/patch. Translated text strings cannot be changed in 8.0.x any more, and will only be accepted in 8.1.x until the first release candidate, so it's just easier if patches with translated text are kept separate from API docs changes.

3. +++ b/core/modules/options/src/Plugin/Field/FieldType/ListIntegerItem.php
   @@ -16,7 +16,7 @@
   + *   description = @Translation("This field stores integer values from a list of allowed 'value => label' pairs; for example, 'Lifetime in days': 1 => 1 day, 7 => 1 week, 31 => 1 month."),
   

   Translated text -> new issue/patch

4. +++ b/core/modules/options/src/Plugin/Field/FieldType/ListStringItem.php
   @@ -17,7 +17,7 @@
   + *   description = @Translation("This field stores text values from a list of allowed 'value => label' pairs; for example, 'US States': IL => Illinois, IA => Iowa, IN => Indiana."),
   

   Translated text -> new issue/patch

5. +++ b/core/modules/quickedit/js/models/FieldModel.js
   @@ -61,9 +61,9 @@
   +       * `<entity type>/<id>/<field name>/<language>`; that is the fieldID
   

   needs comma after "is"

6. +++ b/core/modules/quickedit/js/quickedit.js
   @@ -486,7 +486,7 @@
       *   Callback function to be called when the missing in-place editors (if any)
   -   *   have been inserted into the DOM. i.e. they may still be loading.
   +   *   have been inserted into the DOM; for instance, they may still be loading.
   

   hm. I am not sure what "i.e." really meant here. The docs really don't make sense.

   Maybe actually just delete the whole "i.e. they may still be loading" part? Because this says it's a callback to be called after they are done loading anyway. I think we should just delete that end of the sentence.

7. +++ b/core/modules/quickedit/js/quickedit.js
   @@ -532,11 +532,11 @@
   +   *     - String entityID: a Quick Edit entity identifier; for example "node/1"
   

   comma after example

8. +++ b/core/modules/rdf/rdf.module
   @@ -307,7 +307,7 @@ function rdf_preprocess_node(&$variables) {
   +  // the view mode (for example full vs. teaser).
   

   comma after example

9. +++ b/core/modules/rdf/rdf.module
   @@ -449,8 +449,8 @@ function rdf_preprocess_comment(&$variables) {
   +    // typeof attribute indicates its RDF type (for exmaple, sioc:Post,
   

   example is misspelled

10. +++ b/core/modules/search/search.module
    @@ -501,8 +501,9 @@ function search_index($type, $sid, $langcode, $text) {
    +            // up to this point. For instance, from 100 words and more, it
    +            // decays, to 0.5 at 500 words and 0.3 at 1000 words.
    

    no comma after decays I think?

11. +++ b/core/modules/simpletest/src/AssertContentTrait.php
    @@ -92,7 +92,7 @@ protected function getTextContent() {
    +   * and when you want to use methods, like assertText(), but ignore potential white-space
    

    This line needs rewrapping to under 80 chars

12. +++ b/core/modules/simpletest/src/AssertContentTrait.php
    @@ -92,7 +92,7 @@ protected function getTextContent() {
    +   * and when you want to use methods, like assertText(), but ignore potential white-space
        * caused by HTML output templates.
    

    Also I don't think we want a comma after "methods" here.

13. +++ b/core/modules/simpletest/src/BrowserTestBase.php
    @@ -683,7 +683,8 @@ protected function checkPermissions(array $permissions) {
        * 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, to log in the same user again, then it must be re-assigned
    +   * manually.
    

    I think the "for example, to log in the same user again" should be in () maybe?

14. +++ b/core/modules/simpletest/src/BrowserTestBase.php
    @@ -947,7 +948,7 @@ public function installDrupal() {
    -    // Affects e.g. StreamWrapperManagerInterface::getWrappers().
    +    // Affects method; for example StreamWrapperManagerInterface::getWrappers().
    

    I don't understand why "method" was inserted here. I think it should probably say:

    This affects, for example, StreamWrapper...

    In any case, "for example" should have commas before and after for this usage.

15. +++ b/core/modules/simpletest/src/TestBase.php
    @@ -1181,9 +1181,9 @@ private function changeDatabasePrefix() {
    +   * Allows classes; for example, KernelTestBase, to prime system/extension info
    

    So the punctuation of

    previous clause; for example, next clause

    is only OK if the previous/next are really clauses or the "next clause" part is the end of the sentence.

    It is not OK here, because there is more stuff after the "next clause" part.

    Here I think you need to put (for example, KernelTestBase) in ()

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

    this "for example, to log in..." part needs to be in ()

17. +++ b/core/modules/simpletest/src/WebTestBase.php
    @@ -1698,7 +1699,8 @@ protected function drupalPostForm($path, $edit, $submit, array $options = array(
    +   *   and the value is the button label. For instance,
    

    I think this would be better punctuated as:

    button label; for example, ...

18. +++ b/core/modules/system/src/Plugin/ImageToolkit/GDToolkit.php
    @@ -36,7 +36,8 @@ class GDToolkit extends ImageToolkitBase {
       /**
    -   * Image type represented by a PHP IMAGETYPE_* constant (e.g. IMAGETYPE_JPEG).
    +   * Image type represented by a PHP IMAGETYPE_* constant (for example,
    +   * IMAGETYPE_JPEG).
    

    First line docs of functions and member variables need to be limited to 1 line.

    So you'll need to either just omit the IMAGETYPE_JPEG part, or put it into a separate paragraph.

19. +++ b/core/modules/system/src/Plugin/ImageToolkit/GDToolkit.php
    @@ -431,7 +432,7 @@ public function extensionToImageType($extension) {
    +   *   IMAGETYPE_* constant (for example, IMAGETYPE_JPEG, IMAGETYPE_PNG, etc.).
    

    If you are making that one above into a separate paragraph, you could include this additional example in the paragraph. ;)

20. +++ b/core/modules/system/templates/system-themes-page.html.twig
    @@ -19,11 +19,12 @@
    - *     - notes: Identifies what context this theme is being used in, e.g.,
    - *       default theme, admin theme.
    + *     - notes: Identifies what context this theme is being used in; default
    + *       theme or admin theme.
    

    I am not sure that default and admin are the only possibilities, here, so probably we still need "for example" here?

21. +++ b/core/modules/system/tests/modules/image_test/src/Plugin/ImageToolkit/TestToolkit.php
    @@ -34,7 +34,8 @@ class TestToolkit extends ImageToolkitBase {
    -   * Image type represented by a PHP IMAGETYPE_* constant (e.g. IMAGETYPE_JPEG).
    +   * Image type represented by a PHP IMAGETYPE_* constant (for example,
    +   * IMAGETYPE_JPEG).
    

    See note above about first-line docs being 1 line.

22. +++ b/core/modules/system/tests/modules/twig_extension_test/src/TwigExtension/TestExtension.php
    @@ -19,7 +19,8 @@ class TestExtension extends TwigExtension {
    +   *   function name used in the tag.
    +   *   For example:
    

    The "For example" here should be up on the previous line.

23. +++ b/core/modules/system/tests/modules/twig_extension_test/src/TwigExtension/TestExtension.php
    @@ -37,7 +38,8 @@ public function getFunctions() {
    +   *   filter name used in the tag.
    +   *   For example:
    

    Here too.

24. +++ b/core/modules/taxonomy/src/TermBreadcrumbBuilder.php
    @@ -61,8 +61,8 @@ public function build(RouteMatchInterface $route_match) {
    +    // dependency even though it is not shown in the breadcrumb because, , for
    

    extra comma

25. +++ b/core/modules/text/src/Plugin/Field/FieldWidget/TextareaWidget.php
    @@ -43,8 +43,9 @@ public function formElement(FieldItemListInterface $items, $delta, array $elemen
    -      // Ignore validation errors for formats if formats may not be changed,
    -      // i.e. when existing formats become invalid. See filter_process_format().
    +      // Ignore validation errors for formats if formats may not be changed;
    +      // that is, when existing formats become invalid. See
    +      // filter_process_format().
    

    I think this i.e. really was meant to be "for example" here?

26. +++ b/core/modules/text/src/Plugin/Field/FieldWidget/TextfieldWidget.php
    @@ -43,8 +43,9 @@ public function formElement(FieldItemListInterface $items, $delta, array $elemen
    +      // that is, when existing formats become invalid. See
    

    here too

27. +++ b/core/modules/update/update.authorize.inc
    @@ -76,7 +76,7 @@ function update_authorize_run_update($filetransfer, $projects) {
    + *   The canonical project short name; that is, the name of the module, theme, or
    

    over 80 characters, rewrap

28. +++ b/core/modules/update/update.manager.inc
    @@ -286,8 +286,8 @@ function update_manager_batch_project_get($project, $url, &$context) {
    + * code will eventually be installed, the update manager can transfer files entirely
    

    over 80, rewrap

29. +++ b/core/modules/user/src/PrivateTempStore.php
    @@ -23,8 +23,8 @@
    + * permanently elsewhere; for example,  autosave data, multistep forms, or
    

    extra space after ,

30. +++ b/core/modules/user/src/SharedTempStore.php
    @@ -64,7 +64,8 @@ class SharedTempStore {
       /**
    -   * The owner key to store along with the data (e.g. a user or session ID).
    +   * The owner key to store along with the data (for example, a user or session
    +   * ID).
    

    See earlier note about first-line docs being 1 line.

    Here we can probably shorten it by making the paren part say:

    (such as user or session ID)

31. +++ b/core/modules/user/src/SharedTempStore.php
    @@ -89,7 +90,8 @@ class SharedTempStore {
    +   *   The owner key to store along with the data (for example, a user or
    +   *   session ID).
    

    see previous comment

32. +++ b/core/modules/user/templates/user.html.twig
    @@ -3,8 +3,8 @@
    + * This template is used when viewing a registered user's page.
    + * For example, example.com/user/123. 123 being the user's ID.
    

    The "for example" part should be in parens, not its own "sentence" (it's not a sentence).

    Also please rewrap to nearly 80 char lines.

33. +++ b/core/modules/user/tests/themes/user_test_theme/user.html.twig
    @@ -3,8 +3,8 @@
    + * This template is used when viewing a registered user's page.
    + * For example, example.com/user/123. 123 being the user's ID.
    

    see previous note

34. +++ b/core/modules/views/src/Plugin/views/area/AreaPluginBase.php
    @@ -31,7 +31,7 @@
    +   * The type of this area handler; that is,  'header', 'footer', or 'empty'.
    

    extra space after comma

35. +++ b/core/modules/views/src/Plugin/views/display/DisplayPluginBase.php
    @@ -2337,9 +2337,9 @@ public function buildRenderable(array $args = [], $cache = TRUE) {
    +    // of cacheability metadata (for example: cache contexts), so they can
    

    : should be ,

36. +++ b/core/modules/views/src/Plugin/views/exposed_form/ExposedFormPluginBase.php
    @@ -164,8 +164,8 @@ public function query() {
    +      // Make sure the original order of sorts is preserved.
    +      // For example, a sticky sort is often first.
    

    rewrap to 80 char lines

37. +++ b/core/modules/views/src/Plugin/views/query/Sql.php
    @@ -1398,7 +1398,7 @@ function execute(ViewExecutable $view) {
    +      // (for exaple, COUNT DISTINCT(1) ...) and no pager will return.
    

    example is misspelled

38. +++ b/core/modules/views/src/Plugin/views/style/StylePluginBase.php
    @@ -614,7 +614,7 @@ public function renderGrouping($records, $groupings = array(), $group_rendered =
                   // Not all field handlers return a scalar value,
    -              // e.g. views_handler_field_field.
    +              // For example, views_handler_field_field.
    

    should be

    value; for example, views_handler_field_field

39. +++ b/core/modules/views/src/Plugin/views/style/StylePluginBase.php
    @@ -645,7 +645,7 @@ public function renderGrouping($records, $groupings = array(), $group_rendered =
    +    // @TODO Remove this as soon as possible; for example,  October 2020
    

    extra space after ,

40. +++ b/core/modules/views/src/Plugin/views/wizard/WizardPluginBase.php
    @@ -536,7 +536,7 @@ public static function getSelected(FormStateInterface $form_state, $parents, $de
    +   *   The display ID; for example 'page' or 'block'.
    

    needs comma after example

41. +++ b/core/modules/views/src/Views.php
    @@ -291,8 +291,9 @@ public static function getDisabledViews() {
    +   *  - views name as string; for example,  my_view
    

    extra space after comma

42. +++ b/core/modules/views_ui/js/views-admin.js
    @@ -876,8 +877,8 @@
    +        // If the tabledrag change marker (that is, the "*") has been inserted
    +        // inside a row after the operator label (that is, "And" or "Or")
    

    We could really probably just get rid of the "that is" here.

43. +++ b/core/modules/views_ui/js/views-admin.js
    @@ -939,9 +940,9 @@
    +          // exmaple, "filter1 AND filter2 AND filter3"). So we remove any
    

    example is misspelled

44. +++ b/core/modules/views_ui/src/Tests/DefaultViewsTest.php
    @@ -71,7 +71,7 @@ function testDefaultViews() {
    +    // Check there is an enable link. That is, the view has not been enabled after
    

    over 80 chars, rewrap

45. +++ b/core/modules/views_ui/views_ui.module
    @@ -215,7 +215,7 @@ function views_ui_view_preview_section_rows_links(ViewExecutable $view) {
    +  // paths underneath "admin/structure/views/view/{$view->id()}" (, paths
    

    take out the , and space after (

have addressed the above points.

Much better, thanks!

I think there are only a few items that still need attention:

1. +++ b/core/modules/quickedit/js/models/FieldModel.js
   @@ -272,7 +272,7 @@
   -      //   remote data (e.g. retrieve form from back-end). Upon retrieval of
   +      //   remote data (that is, retrieve form from back-end). Upon retrieval of
   

   Um, I think this one is more of a "for example" than a "that is"? Sorry if I said the opposite in a previous review. ;)

2. +++ b/core/modules/simpletest/src/BrowserTestBase.php
   @@ -947,7 +948,7 @@ public function installDrupal() {
   -    // Affects e.g. StreamWrapperManagerInterface::getWrappers().
   +    // This effects, for example, StreamWrapperManagerInterface::getWrappers().
   

   The correct word here is "affects" (as in the original), not "effects" (as in the current patch).

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

   We should really file a separate issue to remove the 2-3 duplicated lines in this test. Out of scope to do that in this issue, however.

4. +++ b/core/modules/system/templates/system-themes-page.html.twig
   @@ -8,7 +8,7 @@
   + *   - state: State of the theme group; installed or uninstalled.
   

   ; should be a , here

5. +++ b/core/modules/update/src/Form/UpdateManagerInstall.php
   @@ -171,8 +171,9 @@ public function submitForm(array &$form, FormStateInterface $form_state) {
   +    // example, MODULE/) and others list an actual file (that is,
   +    // MODULE/README.TXT).
   

   that is -> for example

6. +++ b/core/modules/update/update.manager.inc
   @@ -154,13 +154,13 @@ function update_manager_archive_extract($file, $directory) {
   +  // MODULE/) and others list an actual file (that is, MODULE/README.TXT).
   

   that is -> for example

7. +++ b/core/modules/user/src/SharedTempStoreFactory.php
   @@ -68,7 +68,7 @@ function __construct(KeyValueExpirableFactoryInterface $storage_factory, LockBac
   +   *   a shared namespace or module name; for exmaple, 'views', 'entity', etc.
   

   example is misspelled

8. +++ b/core/modules/views/views.module
   @@ -376,7 +376,7 @@ function views_add_contextual_links(&$render_element, $location, $display_id, ar
   +    // set 'contextual_links_locations' to; for example, {""}.)
   

   ; should be , here

Updated patch as per comment #15

When making a new patch on an issue that already had a patch, you really MUST make an interdiff file. Thanks!

Anyway... I tried to apply this patch to 8.2.x but it failed to find file core/modules/views/src/Test/PluginInstanceTest.php -- so I guess that needs to be removed from the patch.

That aside, I applied the patch (except that part), and there are a few other places that need fixing in modules N-V. Please be more careful in the future when making these types of cleanup patches to get *all* of the problems.

Anyway, here's the grep output, minus user interface text (which we need to do in a different issue) -- and file paths are relative to core/modules:

node/node.module: * (e.g module settings form), calling node_access_needs_rebuild(TRUE) instead
system/src/Tests/Menu/BreadcrumbTest.php:    // Also verify that the node does not appear elsewhere (e.g., menu trees).
system/src/Tests/Menu/BreadcrumbTest.php:    // Also verify that the node does not appear elsewhere (e.g., menu trees).
views/src/Views.php:   *   A flag from the display plugin definitions (e.g, 'uses_menu_links').
views/tests/src/Kernel/PluginInstanceTest.php:        // We only want to test true plugins, i.e. They extend PluginBase.
views/src/Plugin/views/argument/ArgumentPluginBase.php:    // name field would be 'name' (i.e, the username).
views/src/Plugin/views/argument/ArgumentPluginBase.php:    // name field would be 'name' (i.e, the username).

So, please fix these places, and make an interdiff file that goes back to patch #14, which is the last one I reviewed. Thanks!

Hi Jennifer, here is a re-rolled patch from #14.

Hm. In the interdiff/patch in #18, I still do not see the item from node.module mentioned in comment #17. I didn't look for the other ones, but I would guess if you didn't do that one, you didn't do the others? Please check comment #17 again. Thanks!

Yep, missed those; hidden because I searched for e.g. and i.e. while these were e.g and i.e

Have added an updated patch with the changes as well.

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.

The patch in comment #21 is failed to apply.

This will fix this.

This will fix.

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

Adding coding standards tag. Coding standards issues are typically tasks, changing category.