Skip to content

Commit 5e900e3

Browse files
committed
Add a note to the style guide about abbreviations
resolves #1824 After the section on specific terms, but before "simple language", add a section that explains that documentation should spell out acronyms, preferring the "<full-spelling> (<acronym>)" format.
1 parent 0164145 commit 5e900e3

1 file changed

Lines changed: 11 additions & 0 deletions

File tree

documentation/style-guide.rst

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -116,6 +116,17 @@ 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+
119130
Use simple language
120131
===================
121132

0 commit comments

Comments
 (0)