Commit 5d237f4
committed
tree-wide: make doc-strings RST-compliant
sphinx became stricter when handling interpreted text without a role,
e.g. "`foo`" since [1], see [2]. This results in errors such as:
sphinx.errors.SphinxError: cannot determine default role!
In the past, heuristics were used to determine how
to format the text (inline code, italic, ..).
In labgrid, interpreted text without a role is used inconsistently. Most
times it was actually meant to be either inline code ("``foo``"), italic
text or links to docs sections or class definitions.
Fix all such occurrences with explicit variants that actually make sense
in their respective contexts.
[1] sphinx-doc/sphinx@114093c
[2] sphinx-doc/sphinx#13904
Signed-off-by: Bastian Krause <[email protected]>1 parent 8d5b351 commit 5d237f4
File tree
3 files changed
+6
-6
lines changed- labgrid
- driver
- power
- pytestplugin
3 files changed
+6
-6
lines changed| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
12 | 12 | | |
13 | 13 | | |
14 | 14 | | |
15 | | - | |
| 15 | + | |
16 | 16 | | |
17 | | - | |
| 17 | + | |
18 | 18 | | |
19 | 19 | | |
20 | 20 | | |
| |||
60 | 60 | | |
61 | 61 | | |
62 | 62 | | |
63 | | - | |
| 63 | + | |
64 | 64 | | |
65 | 65 | | |
66 | 66 | | |
| |||
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
3 | 3 | | |
4 | 4 | | |
5 | 5 | | |
6 | | - | |
| 6 | + | |
7 | 7 | | |
8 | 8 | | |
9 | 9 | | |
| |||
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
113 | 113 | | |
114 | 114 | | |
115 | 115 | | |
116 | | - | |
| 116 | + | |
117 | 117 | | |
118 | 118 | | |
119 | 119 | | |
| |||
124 | 124 | | |
125 | 125 | | |
126 | 126 | | |
127 | | - | |
| 127 | + | |
128 | 128 | | |
129 | 129 | | |
130 | 130 | | |
| |||
0 commit comments