File tree Expand file tree Collapse file tree 1 file changed +14
-3
lines changed
Expand file tree Collapse file tree 1 file changed +14
-3
lines changed Original file line number Diff line number Diff line change @@ -54,10 +54,15 @@ starting it with a lowercase letter should be avoided.
5454Many special names are used in the Python documentation, including the names of
5555operating systems, programming languages, standards bodies, and the like. Most
5656of these entities are not assigned any special markup, but the preferred
57- spellings are given here to aid authors in maintaining the consistency of
58- presentation in the Python documentation.
57+ spellings are given in :ref: ` specific words ` to aid authors in maintaining the
58+ consistency of presentation in the Python documentation.
5959
60- Other terms and words deserve special mention as well; these conventions should
60+ .. _specific words :
61+
62+ Specific words
63+ ==============
64+
65+ Some terms and words deserve special mention. These conventions should
6166be used to ensure consistency throughout the documentation:
6267
6368C API
7984 used to produce Python documentation. When spelled out, it is
8085 always one word and both forms start with a lowercase 'r'.
8186
87+ time zone
88+ When referring to a Python term like a module, class, or argument spell it
89+ as one word with appropriate markup (for example, ``:mod:`timezone` ``).
90+ When talking about the real-world concept spell it as two words with no
91+ markup.
92+
8293Unicode
8394 The name of a character coding system. This is always written
8495 capitalized.
You can’t perform that action at this time.
0 commit comments