Open
Description
Names of attributes, variables, files, etc. should be marked as <code>
in HTML, i.e. use double backticks in ReST.
Jargon can be marked up using *emphasis*
.
Most of these terms are noted as exceptions in Doc/spelling_wordlist.txt
. Removing a word from there will make tests fail with pointers to where the words are used in plain text. (Note that autodoc
merges text from source code; when it does, you'll need to search for the offending docstring.)