Skip to content

Commit 5d237f4

Browse files
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 <bst@pengutronix.de>
1 parent 8d5b351 commit 5d237f4

File tree

3 files changed

+6
-6
lines changed

3 files changed

+6
-6
lines changed

labgrid/driver/dockerdriver.py

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -12,9 +12,9 @@
1212

1313

1414
class PullPolicy(Enum):
15-
"""Pull policy for the `DockerDriver`.
15+
"""Pull policy for the DockerDriver.
1616
17-
Modelled after `podman run --pull` / `docker run --pull`.
17+
Modelled after ``podman run --pull`` / ``docker run --pull``.
1818
1919
* always: Always pull the image and throw an error if the pull fails.
2020
* missing: Pull the image only when the image is not in the local
@@ -60,7 +60,7 @@ class DockerDriver(PowerProtocol, Driver):
6060
bindings (dict): The labgrid bindings
6161
Args passed to docker.create_container:
6262
image_uri (str): The uri of the image to fetch
63-
pull (str): Pull policy. Default policy is `always` for backward
63+
pull (str): Pull policy. Default policy is ``always`` for backward
6464
compatibility concerns
6565
command (str): The command to execute once container has been created
6666
volumes (list): The volumes to declare

labgrid/driver/power/ubus.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
handy if devices are connected to a PoE switch running OpenWrt.
44
55
The URL given in hosts in exporter.yaml must accept unauthenticated UBUS
6-
calls for the two `poe` calls `info` and `manage`.
6+
calls for the two ``poe`` calls ``info`` and ``manage``.
77
88
Further information is availbe at https://openwrt.org/docs/techref/ubus#acls
99

labgrid/pytestplugin/fixtures.py

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -113,7 +113,7 @@ def env(request, record_testsuite_property):
113113

114114
@pytest.fixture(scope="session")
115115
def target(env):
116-
"""Return the default target `main` configured in the supplied
116+
"""Return the default target "main" configured in the supplied
117117
configuration file."""
118118
target = env.get_target()
119119
if target is None:
@@ -124,7 +124,7 @@ def target(env):
124124

125125
@pytest.fixture(scope="session")
126126
def strategy(request, target):
127-
"""Return the Strategy of the default target `main` configured in the
127+
"""Return the Strategy of the default target "main" configured in the
128128
supplied configuration file."""
129129
try:
130130
strategy = target.get_driver("Strategy")

0 commit comments

Comments
 (0)