Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Remove e.g. and i.e. throughout #1343

Merged
merged 2 commits into from
Jul 5, 2024
Merged

Conversation

nedbat
Copy link
Member

@nedbat nedbat commented Jul 2, 2024

I'm not sure if this is controversial or not. It's ready to merge if people like it.


📚 Documentation preview 📚: https://cpython-devguide--1343.org.readthedocs.build/

Copy link
Contributor

@erlend-aasland erlend-aasland left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks; I like this very much!

documentation/style-guide.rst Outdated Show resolved Hide resolved
getting-started/pull-request-lifecycle.rst Outdated Show resolved Hide resolved
@ezio-melotti
Copy link
Member

Is there any background for this decision?
I did a quick search and there are some article about using e.g. instead of eg or eg., but didn't find style guides that recommend against using them.

Copy link
Member

@ezio-melotti ezio-melotti left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

From those links:

  • Google:

    Prefer English terms over Latin abbreviations. Don't use i.e. or e.g.; instead, use that is or for example, respectively. One exception: it's okay to use etc. in some circumstances.

    Avoid using etc., and so forth, and and so on wherever possible. If you really need to use one, use etc. Always include the period, even if a comma follows immediately after.

  • Microsoft

    Avoid Latin abbreviations for common English phrases.
    Exception It’s OK to use etc., in situations where space is limited. Otherwise, see and so on for alternatives.

  • Red Hat:

    Take care also with abbreviations; replace "e.g." with "for example", and replace "i.e." with "that is", and so on.

  • Apple:

    Latin: Avoid using Latin abbreviations.
    Correct: for example, and others, and so on, and that is, or equivalent phrases
    Incorrect: e.g. (for example), et al. (and others), etc. (and so on), i.e. (that is)

I personally like to use those abbreviations but the style guides disagree with me, and I agree with the style guides.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants