Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 6 additions & 0 deletions documentation/markup.rst
Original file line number Diff line number Diff line change
Expand Up @@ -703,8 +703,14 @@ In the CPython documentation, there are a couple common cases
where simpler markup should be used:

* ``*arg*`` (rendered as *arg*) for function and method arguments.

* ````True````/````False````/````None```` for ``True``/``False``/``None``.

* ``Full Spelling (abbreviation)`` for abbreviations and acronyms.

The ``:abbr:`` role generates HTML which is not accessible to some forms of
assistive technology and mobile users.

In addition, the CPython documentation defines a few custom roles:

* ``:gh:`ID```: link to a GitHub issue.
Expand Down
4 changes: 4 additions & 0 deletions documentation/style-guide.rst
Original file line number Diff line number Diff line change
Expand Up @@ -68,6 +68,10 @@ be native English speakers.
Don't use Latin abbreviations like "e.g." or "i.e." where English words will do,
such as "for example" or "that is."

In general, the first time an acronym is used on a page, spell it out.
Prefer to write out the full term and follow it with the acronym in parentheses.
For example, write "JavaScript Object Notation (JSON)".

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
For example, write "JavaScript Object Notation (JSON)".
For example, write "Basic Multilingual Plane (BMP)".

I think 'JSON' is common enough that we don't always need to provide the full term. I suggest we use BMP instead (the abbreviation that led to the issue).



Charged terminology to avoid
============================
Expand Down
Loading