commit a737624f08aa2a46ff6a91c5459c7644b1e26e3b Author: Dave Rolek dmr-x@riseup.net Date: Wed Aug 8 19:13:15 2018 +0000
Standardize some docstring keywords
s/:parm /:param / s/:raise:/:raises:/ s/:return:/:returns:/ --- stem/client/cell.py | 14 +++++++------- stem/util/log.py | 2 +- stem/util/term.py | 2 +- 3 files changed, 9 insertions(+), 9 deletions(-)
diff --git a/stem/client/cell.py b/stem/client/cell.py index f18318da..5ad57788 100644 --- a/stem/client/cell.py +++ b/stem/client/cell.py @@ -104,9 +104,9 @@ class Cell(object): """ Provides cell attributes by its name.
- :parm str name: cell command to fetch + :param str name: cell command to fetch
- :raise: **ValueError** if cell type is invalid + :raises: **ValueError** if cell type is invalid """
for _, cls in inspect.getmembers(sys.modules[__name__]): @@ -120,9 +120,9 @@ class Cell(object): """ Provides cell attributes by its value.
- :parm int value: cell value to fetch + :param int value: cell value to fetch
- :raise: **ValueError** if cell type is invalid + :raises: **ValueError** if cell type is invalid """
for _, cls in inspect.getmembers(sys.modules[__name__]): @@ -202,9 +202,9 @@ class Cell(object): :param bytes payload: cell payload :param int circ_id: circuit id, if a CircuitCell
- :return: **bytes** with the encoded payload + :returns: **bytes** with the encoded payload
- :raise: **ValueError** if cell type invalid or payload makes cell too large + :raises: **ValueError** if cell type invalid or payload makes cell too large """
if issubclass(cls, CircuitCell): @@ -369,7 +369,7 @@ class RelayCell(CircuitCell): :var stem.client.RelayCommand command: command to be issued :var int command_int: integer value of our command :var bytes data: payload of the cell - :var int recognized: zero if cell is decrypted, non-zero otherwise + :var int recognized: zero if cell is decrypted, otherwise mostly non-zero (can rarely be zero) :var int digest: running digest held with the relay :var int stream_id: specific stream this concerns """ diff --git a/stem/util/log.py b/stem/util/log.py index 81fc88a6..0b2de90a 100644 --- a/stem/util/log.py +++ b/stem/util/log.py @@ -103,7 +103,7 @@ def get_logger(): """ Provides the stem logger.
- :return: **logging.Logger** for stem + :returns: **logging.Logger** for stem """
return LOGGER diff --git a/stem/util/term.py b/stem/util/term.py index 3c6fe73a..b4acd61f 100644 --- a/stem/util/term.py +++ b/stem/util/term.py @@ -80,7 +80,7 @@ def encoding(*attrs): :data:`~stem.util.terminal.BgColor`, or :data:`~stem.util.terminal.Attr` to provide an ecoding for
- :return: **str** of the ANSI escape sequence, **None** no attributes are + :returns: **str** of the ANSI escape sequence, **None** no attributes are recognized """