mirror of
https://github.com/torproject/stem.git
synced 2024-12-04 16:36:28 +00:00
4f55589f83
Our methods document parater types twice...
def my_method(my_arg: str) => None:
"""
Dummy method.
:param str my_arg: sample argument
"""
The method signature and :param: reStructured tag both cite our my_arg type.
By using Sphinx's sphinx_autodoc_typehints plugin we can drop our parameter
types...
https://github.com/agronholm/sphinx-autodoc-typehints
Deduplication aside this makes our API docs look nicer by stripping Python
type hints from our signatures. In other words...
stem.util.system.is_available(command: str, cached: bool = True) → bool
Parameters:
command (str) -- command to search for
cached (bool) -- makes use of available cached results if True
... becomes...
stem.util.system.is_available(command, cached=True)
Parameters:
command (str) -- command to search for
cached (bool) -- makes use of available cached results if True
|
||
|---|---|---|
| .. | ||
| _static | ||
| _templates | ||
| api | ||
| tutorials | ||
| api.rst | ||
| change_log.rst | ||
| conf.py | ||
| contents.rst | ||
| download.rst | ||
| faq.rst | ||
| index.rst | ||
| Makefile | ||
| roles.py | ||
| tutorials.rst | ||