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

Decide on use of comma after "e.g." and "i.e." #3235

Closed
henrikt-ma opened this issue Sep 6, 2022 · 4 comments · Fixed by #3329
Closed

Decide on use of comma after "e.g." and "i.e." #3235

henrikt-ma opened this issue Sep 6, 2022 · 4 comments · Fixed by #3329
Assignees
Milestone

Comments

@henrikt-ma
Copy link
Collaborator

Our style guide should give rules for when to use a comma after "e.g." and "i.e.", and the text should be updated to follow whatever is decided. Currently we have a mix of both:

  • i.e. with comma: 111
  • i.e. without comma: 56 (one of which without protecting the following space)
  • e.g. with comma: 69
  • e.g. without comma:85

Based on what I find online, including discussions like this,
https://english.stackexchange.com/questions/16172/should-i-always-use-a-comma-after-e-g-or-i-e
I lean towards always requiring the comma for both abbreviations in our document. This would also have the advantage that people editing the sources don't need to remember the special LaTeX behavior that requires the following space to be protected when it appears directly after the period.

@dietmarw
Copy link
Member

dietmarw commented Sep 6, 2022

I'm also in favour of always using the comma.

@HansOlsson HansOlsson added this to the Phone 2022-4 milestone Sep 6, 2022
@eshmoylova
Copy link
Member

I have consulted with our documentation team. Their recommendation (based on Chicago Manual of Style) is that comma should be used after. Before there should also be some punctuation mark. Examples of a punctuation mark before (from the specification):

...trajectories for the model's variables, i.e., the value of the variables...

...for rem(x,y) it is div(x,y) - i.e. events are not generated when...

...objects (i.e., components).

I haven't looked through all the cases of "i.e." and "e.g". There was one case where there was no punctuation mark before.

@HansOlsson
Copy link
Collaborator

It seems we have consensus, and will try to do it when we have few open PRs.

@casella
Copy link
Collaborator

casella commented Dec 12, 2022

As I understand, "i.e." is short for "id est", Latin for "that is", and "e.g." is short for "exempli gratia", Latin for "for the sake of the example", which in English (and I guess also in medieval Latin) are always preceded and followed by a comma. That's why we should always write them ", e.g.," and ", i.e.,".

HansOlsson added a commit to HansOlsson/ModelicaSpecification that referenced this issue Jan 2, 2023
@HansOlsson HansOlsson mentioned this issue Jan 2, 2023
HansOlsson added a commit that referenced this issue Jan 31, 2023
* Search and replace fixes.
Closes #3235
* Additional ones.
Note that I replaced the use of colon before an example with ",".
Clearly "e.g.,:" would seem excessive, and it wasn't clear that "e.g.:" is really correct (and it is at least rare).
https://en.wikipedia.org/wiki/Colon_(punctuation) indicates that the part before colon should be a complete sentence and these abbrevs. aren't.
* Update chapters/classes.tex
* Apply suggestions from code review
Restore case
* Add it to the style guide as well.
* Comma Before according to review
* One more missing comma before
* Better explanation of when to use comma
* Apply suggestions from code review
* Additional missing comma before.
Note that one sentence was rewritten to add a parenthesis around the example-text.

Co-authored-by: Elena Shmoylova <eshmoylova@users.noreply.github.com>
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 a pull request may close this issue.

5 participants