Skip to content

Development Documentation: follow guidelies regarding Latin abbreviations

Thiago Figueiró requested to merge (removed):docs/minor-typos into master

What does this MR do?

The Language section of the Documentation Style Guide states:

We discourage use of Latin abbreviations, such as “e.g.,” “i.e.,” or “etc.,” as even native users of English might misunderstand them.

  • Instead of “i.e.”, use “that is.”
  • Instead of “e.g.”, use “for example,” “such as,” “for instance,” or “like.”
  • Instead of “etc.”, either use “and so on” or consider editing it out, since it can be vague.

The same document then goes on to use said abbreviations.

This MR fixes this by following its own recommendations. It also fixes a missing period that occurs right under the recommendation to finish sentences with a period. :)

Screenshots

N/A

Does this MR meet the acceptance criteria?

N/A

Conformity

Availability and Testing

N/A

Security

N/A

Merge request reports