Problem/Motivation

The proper use of 'e.g.' and 'i.e.' are confusing and reportedly are one of the most frequent sources of mistakes editors see in technical writing/documentation. Drupal's docblock and code documentation includes some examples of incorrect usage as well.

Let's start to correct some of that confusion by replacing 'e.g.,' by what it means in English: 'for instance,'. This will require a number of patches until 'e.g.' is appropriately replaced. Based on the first round, the patch size should be around 50k.

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.

Steps to reproduce

Proposed resolution

Remaining tasks

Postponed on #2714651: Add a rule for replacing e.g. and i.e. with English words

User interface changes

API changes

Data model changes

Release notes snippet

Comments

malavya created an issue. See original summary.

aditya_anurag’s picture

aditya_anurag commented
Assigned: Unassigned » aditya_anurag
aditya_anurag’s picture

aditya_anurag commented
Assigned: aditya_anurag » Unassigned
jhodgdon’s picture

jhodgdon
she/her
Primary language English
commented
Category: Bug report » Plan

@malavya -- THANKS for making this meta and renaming all the child issues!

Meta issues should be category "Plan", for future reference. They should stay as Active until all of their child issues are fixed.

jhodgdon’s picture

jhodgdon
she/her
Primary language English
commented

Note: This issue needs one more child issue that would fix i.e. and e.g. in user interface text, throughout Core. The other issues should be limited to API documentation and code comments. Thanks!

joyceg’s picture

joyceg commented

This is really something we need to work out. Often people get confused by these words. So, it's preferred to give some kind of an expansion.

pashupathi nath gajawada’s picture

pashupathi nath gajawada commented
Assigned: Unassigned » pashupathi nath gajawada
jhodgdon’s picture

jhodgdon
she/her
Primary language English
commented
Assigned: pashupathi nath gajawada » Unassigned

RE #7 - we are working on this issue in several child issues. Please do your work there and do not assign this "meta" (master) issue to yourself. Thanks!

pashupathi nath gajawada’s picture

pashupathi nath gajawada commented

Hi @jhodgdon,

Thanks for the info, I was not aware that this "meta" (master) issues should not be assigned.

jhodgdon’s picture

jhodgdon
she/her
Primary language English
commented

On one of the child issues, #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.

Please add an issue in Coder for a rule that will "sniff" i.e. and e.g. (with or without the final .), and make it a child of this issue, and then we can proceed with the other issues.

imalabya’s picture

imalabya
Primary language English
Location Bangalore
commented

Hi jhodgdon,

have added the issue for coder rule for this as a child issue https://www.drupal.org/node/2714651

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.

Bojhan’s picture

Bojhan commented

This sounds like a great plan. What is now the proposal for a new set of terms?

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.

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.

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.

cilefen’s picture

cilefen commented

Based on how long it is taking to patch this I am faced with two contradictory thoughts:

  1. According to the issue summary, people are reportedly confused by these. Where are the reports? How confusing is this really as compared to other documentation bugs?
  2. The difficultly contributors have in fixing these makes me think “yeah, people are confused by these”.
xjm’s picture

xjm
she/her
Primary language English
commented
Status: Active » Postponed

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

xjm’s picture

xjm
she/her
Primary language English
commented

Also, once the coder rule is added, maybe we should handle i.e. and e.g. separately? The replacement for e.g. is usually "for example" unless it's used incorrectly, but i.e. can depend more on context and usage.

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.

quietone’s picture

quietone commented
Issue summary: View changes

This came up at a documentation triage meeting. I am adding the standard template and updating the is.

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.

Version: 11.x-dev » main

Drupal core is now using the main branch as the primary development branch. New developments and disruptive changes should now be targeted to the main branch.

Read more in the announcement.

quietone’s picture

quietone commented
Related issues: +#2760911: Use of "e.g." and "i.e."

The related issue in the Coding Standard project has been closed as won't fix. #2760911: Use of "e.g." and "i.e."