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

Replace e.g. with for example #33515

Closed
wants to merge 1 commit into from
Closed

Conversation

quaff
Copy link
Contributor

@quaff quaff commented Sep 10, 2024

Latin abbreviation is not readable for non-native English speakers.

@spring-projects-issues spring-projects-issues added the status: waiting-for-triage An issue we've not yet triaged or decided on label Sep 10, 2024
Copy link
Member

@sbrannen sbrannen left a 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.

@sbrannen sbrannen added type: documentation A documentation task status: waiting-for-feedback We need additional information before we can continue labels Sep 10, 2024
@quaff
Copy link
Contributor Author

quaff commented Sep 10, 2024

I'll try.

@spring-projects-issues spring-projects-issues added status: feedback-provided Feedback has been provided and removed status: waiting-for-feedback We need additional information before we can continue labels Sep 10, 2024
@quaff quaff force-pushed the patch-83 branch 2 times, most recently from 7c39a19 to 50b12ef Compare September 10, 2024 09:13
@quaff
Copy link
Contributor Author

quaff commented Sep 10, 2024

@sbrannen I've updated.

@snicoll snicoll removed the type: documentation A documentation task label Sep 10, 2024
@sbrannen sbrannen added this to the 6.2.x milestone Sep 10, 2024
@sbrannen sbrannen added type: documentation A documentation task and removed status: waiting-for-triage An issue we've not yet triaged or decided on status: feedback-provided Feedback has been provided labels Sep 10, 2024
Latin abbreviation is not readable for non-native English speakers.
@sbrannen sbrannen modified the milestones: 6.2.x, 6.2.0-RC2 Sep 24, 2024
@sbrannen sbrannen self-assigned this Sep 26, 2024
@sbrannen sbrannen changed the title Replace E.g. with For example Replace e.g. with for example Sep 26, 2024
@sbrannen sbrannen closed this in 8941e28 Sep 26, 2024
@sbrannen
Copy link
Member

This has been merged into main.

Thanks for modifying all 724 files! 😮

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

Successfully merging this pull request may close these issues.

4 participants