Há um exemplo doctstring para Sphinx em sua documentação. Especificamente, eles mostram o seguinte:
def public_fn_with_googley_docstring(name, state=None):
"""This function does something.
Args:
name (str): The name to use.
Kwargs:
state (bool): Current state to be in.
Returns:
int. The return code::
0 -- Success!
1 -- No good.
2 -- Try again.
Raises:
AttributeError, KeyError
A really great idea. A way you might use me is
>>> print public_fn_with_googley_docstring(name='foo', state=None)
0
BTW, this always returns 0. **NEVER** use with :class:`MyPublicClass`.
"""
return 0
Embora você tenha perguntado sobre esfingeexplicitamente, eu também apontaria para o Guia de estilo do Google Python . Seu exemplo de docstring parece implicar que eles não chamam kwargs especificamente. (other_silly_variable = None)
def fetch_bigtable_rows(big_table, keys, other_silly_variable=None):
"""Fetches rows from a Bigtable.
Retrieves rows pertaining to the given keys from the Table instance
represented by big_table. Silly things may happen if
other_silly_variable is not None.
Args:
big_table: An open Bigtable Table instance.
keys: A sequence of strings representing the key of each table row
to fetch.
other_silly_variable: Another optional variable, that has a much
longer name than the other args, and which does nothing.
Returns:
A dict mapping keys to the corresponding table row data
fetched. Each row is represented as a tuple of strings. For
example:
{'Serak': ('Rigel VII', 'Preparer'),
'Zim': ('Irk', 'Invader'),
'Lrrr': ('Omicron Persei 8', 'Emperor')}
If a key from the keys argument is missing from the dictionary,
then that row was not found in the table.
Raises:
IOError: An error occurred accessing the bigtable.Table object.
"""
pass
A ABB tem uma pergunta sobre a resposta aceita de fazer referência à documentação de gerenciamento de subprocesso. Se você importar um módulo, poderá ver rapidamente as docstrings do módulo por meio de inspect.getsource.
Um exemplo do interpretador python usando a recomendação do Silent Ghost:
>>> import subprocess
>>> import inspect
>>> import print inspect.getsource(subprocess)
É claro que você também pode visualizar a documentação do módulo por meio da função de ajuda. Por exemplo, ajuda (subprocesso)
Pessoalmente, não sou um fã do subprocesso docstring para kwargs como exemplo, mas como o exemplo do Google, ele não lista kwargs separadamente, conforme mostrado no exemplo de documentação do Sphinx.
def call(*popenargs, **kwargs):
"""Run command with arguments. Wait for command to complete, then
return the returncode attribute.
The arguments are the same as for the Popen constructor. Example:
retcode = call(["ls", "-l"])
"""
return Popen(*popenargs, **kwargs).wait()
Estou incluindo esta resposta à pergunta da ABB porque vale a pena observar que você pode revisar a fonte ou a documentação de qualquer módulo dessa forma para obter insights e inspiração para comentar seu código.