Skip to content

Commit 7982840

Browse files
committed
Minor documentation fixes
1 parent 86ca27f commit 7982840

1 file changed

Lines changed: 5 additions & 5 deletions

File tree

nxt/brick.py

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -90,7 +90,7 @@ class Brick:
9090
Create an instance with :func:`nxt.locator.find`.
9191
9292
The :class:`Brick` object implements the context manager interface, so you can use
93-
it with the `with` syntax to close the connection when done with it.
93+
it with the ``with`` syntax to close the connection when done with it.
9494
"""
9595

9696
def __init__(self, sock):
@@ -169,8 +169,8 @@ def open_file(
169169
meaning as the standard :func:`open` function, they must be given as keyword
170170
parameters.
171171
172-
When `encoding` is None or not given, it defaults to ``ascii`` as this is the
173-
only encoding understood by the NXT brick.
172+
When `encoding` is ``None`` or not given, it defaults to ``ascii`` as this is
173+
the only encoding understood by the NXT brick.
174174
"""
175175
rw = None
176176
tb = None
@@ -285,7 +285,7 @@ def get_sensor(self, port, cls=None, *args, **kwargs):
285285
"""Return a sensor object connected to one of the brick input port.
286286
287287
:param nxt.sensor.Port port: Input port identifier.
288-
:param cls: Sensor class, or None to autodetect.
288+
:param cls: Sensor class, or ``None`` to autodetect.
289289
:type cls: typing.Type[nxt.sensor.Sensor] or None
290290
:param args: Additional constructor positional arguments when `cls` is given.
291291
:param kwargs: Additional constructor keyword arguments when `cls` is given.
@@ -317,7 +317,7 @@ def _cmd(self, tgram):
317317
"""Send a message to the NXT brick and read reply.
318318
319319
:param nxt.telegram.Telegram tgram: Message to send.
320-
:return: Reply message after status has been checked, or None if no reply
320+
:return: Reply message after status has been checked, or ``None`` if no reply
321321
requested.
322322
:rtype: nxt.telegram.Telegram or None
323323
"""

0 commit comments

Comments
 (0)