Use "e.g.", "e.g.," or "for example"
- Dominant language
- Rust
- Stars
- 30.5k
- Forks
- 3.2k
- Avg merge
- 2d 8h
- Merged PRs (30d)
- 72
Description
I had a discussion with @brishtibheja [here](https://github.com/ankitects/anki-manual/pull/414#discussion_r2145205528) about whether to use `e.g.` (British) or `e.g.,` (American), and @Danika-Dakika mentioned [here](https://github.com/ankitects/anki-manual/pull/414#discussion_r2160198004) that we usually stick with American style. I originally thought we should stick to [whichever is more commonly used](https://github.com/ankitects/anki-manual/pull/414#discussion_r2145420922) in the manual.
But I looked it up on major tech companies' style guide. They actually discourage using the abbreviation "e.g." entirely.
[Google](https://developers.google.com/style/word-list#eg):
> Don't use. Instead, use phrases like for example or such as. Many people confuse e.g. and i.e.
[Apple](https://support.apple.com/en-al/guide/applestyleguide/apsg076a7313/1.0/web/1.0#:~:text=or%20HED.-,e.g.,-Don%E2%80%99t%20use%3B%20use):
> Don’t use; use for example or such as.
[Microsoft](https://learn.microsoft.com/en-us/style-guide/a-z-word-list-term-collections/e/eg):
> Don't use. Use for example, such as, or like, as appropriate.
I think it would be best if we just follow the norm. They probably have done their research on this and that's why they reached the same conclusions.
So my opinion now is to not use "e.g." and use "for example" and "such as". What do you think?
Contributor guide
Research direction
Start with the issue discussion and the linked pull-request comments, then review the cited Google, Apple, and Microsoft style guides. The issue does not name files or tests; done would require a project decision on the preferred wording and a defined scope for applying it.
Written by the indexing model from the issue text.
Assessment
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 20/100