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.

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.

Ironically nothing in the devguide defines the "HTML" abbreviation which you use in the other part of this PR. And I think that's a good thing: in computing there are some terms that are more widely understood as abbreviations than as the full form, and adding the full form is more likely to distract than to help readers. HTML is one of those terms. Other examples off the top of my head are UTF-8, PNG, SVG, SQL.

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

Yeah, sometimes an acronym becomes a term or word in its own right.
The guidance should be read as flexible in this respect.

We added the "In general" to try to succinctly cover this. Do you feel it needs more explanation? We can try another arrangement if the current text looks too strong.

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.

The current text will likely lead people to comment that you need to say "Hyper-Text Markup Language". I'd suggest wording like "Commonly understood acronyms such as HTML or UTF-8 do not need to be expanded."

Prefer to write out the full term and follow it with the acronym in parentheses.
For example, write "Basic Multilingual Plane (BMP)".


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