Skip to content

Commit 3b5d5b5

Browse files
committed
Split :abbr: vs "acronym howto" docs go
The role is documented in with other sphinx roles. In order for the rst to read easily, one line of non-semantic whitespace was added to a list. The acronym usage note is moved to the end of "Use simple language"
1 parent 5e900e3 commit 3b5d5b5

2 files changed

Lines changed: 10 additions & 11 deletions

File tree

documentation/markup.rst

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -703,8 +703,14 @@ In the CPython documentation, there are a couple common cases
703703
where simpler markup should be used:
704704

705705
* ``*arg*`` (rendered as *arg*) for function and method arguments.
706+
706707
* ````True````/````False````/````None```` for ``True``/``False``/``None``.
707708

709+
* ``Full Spelling (abbreviation)`` for abbreviations and acronyms.
710+
711+
The ``:abbr:`` role generates HTML which is not accessible to some forms of
712+
assistive technology and mobile users.
713+
708714
In addition, the CPython documentation defines a few custom roles:
709715

710716
* ``:gh:`ID```: link to a GitHub issue.

documentation/style-guide.rst

Lines changed: 4 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -116,17 +116,6 @@ Unix
116116
1970s.
117117

118118

119-
Spell out acronyms
120-
==================
121-
122-
The first time an acronym is used on a page, spell it out.
123-
Prefer to write out the full term and follow it with the acronym in parentheses.
124-
For example, write "JavaScript Object Notation (JSON)".
125-
126-
Avoid using the ``:abbr:`` role, as it generates HTML which is not accessible to
127-
some forms of assistive technology and mobile users.
128-
129-
130119
Use simple language
131120
===================
132121

@@ -136,6 +125,10 @@ be native English speakers.
136125
Don't use Latin abbreviations like "e.g." or "i.e." where English words will do,
137126
such as "for example" or "that is."
138127

128+
The first time an acronym is used on a page, spell it out.
129+
Prefer to write out the full term and follow it with the acronym in parentheses.
130+
For example, write "JavaScript Object Notation (JSON)".
131+
139132

140133
Charged terminology to avoid
141134
============================

0 commit comments

Comments
 (0)