Skip to content

Commit ad593c7

Browse files
vonunwerthschodet
authored andcommitted
Changed rtype in docstring of find_brick for autocompletion
With rtype set to nxt.brick.Brick instead of just Brick you can use autocomplete for a Brick instance. (also for find_with_options)
1 parent 31f6afe commit ad593c7

1 file changed

Lines changed: 2 additions & 2 deletions

File tree

nxt/locator.py

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -126,7 +126,7 @@ def find(
126126
:type host: str or None
127127
:param filters: Additional filter keywords or backends parameters.
128128
:return: The found brick, or an iterator if `find_all` is ``True``
129-
:rtype: Brick or Iterator[Brick]
129+
:rtype: nxt.brick.Brick or Iterator[nxt.brick.Brick]
130130
:raises BrickNotFoundError: if no brick is found and `find_all` is ``False``.
131131
132132
Use this function to find a NXT brick. You can pass arguments to match a specific
@@ -267,7 +267,7 @@ def find_with_options(options, *, find_all=False):
267267
:meth:`argparse.ArgumentParser.parse_args`
268268
:param bool find_all: ``True`` to return an iterator over all bricks found.
269269
:return: The found brick or ``None``, or an iterator if `find_all` is ``True``.
270-
:rtype: Brick or None or Iterator[Brick]
270+
:rtype: nxt.brick.Brick or None or Iterator[nxt.brick.Brick]
271271
272272
This is to be used together with :func:`add_arguments`. It calls :func:`find` with
273273
options received on the command line.

0 commit comments

Comments
 (0)