-
Notifications
You must be signed in to change notification settings - Fork 38.3k
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
Replace e.g.
with for example
#33515
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I agree that we should stop using e.g.
in our documentation; however, we should do that consistently across Javadoc and the reference manual.
Searching for e.g.
(ignoring case) reveals 1168 occurrences in *.java
files and 76 occurrences in *.adoc
files on main
. We also use e.g.
in *.dtd
and *.xsd
files.
So, if we're going to do this, we should do it for all occurrences.
In addition, for statements like E.g. the following class implements a singleton
, we should write For example, the following class implements a singleton
(note the comma).
For places where e.g.
comes in the middle of a sentence, it should typically be replaced with , for example,
and sometimes with — for example,
, depending on the context.
Please let us know if you'd like to update this PR to address all such occurrences.
I'll try. |
7c39a19
to
50b12ef
Compare
@sbrannen I've updated. |
Latin abbreviation is not readable for non-native English speakers.
This has been merged into Thanks for modifying all 724 files! 😮 |
Latin abbreviation is not readable for non-native English speakers.