File tree 1 file changed +14
-3
lines changed
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.
54
54
Many special names are used in the Python documentation, including the names of
55
55
operating systems, programming languages, standards bodies, and the like. Most
56
56
of 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.
59
59
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
61
66
be used to ensure consistency throughout the documentation:
62
67
63
68
C API
79
84
used to produce Python documentation. When spelled out, it is
80
85
always one word and both forms start with a lowercase 'r'.
81
86
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
+
82
93
Unicode
83
94
The name of a character coding system. This is always written
84
95
capitalized.
You can’t perform that action at this time.
0 commit comments