В их документации есть пример строки доктрины для Sphinx. В частности, они показывают следующее:
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
Хотя вы и спрашивали о sphinx в явном виде, я бы также указал на Руководство по стилю Google Python . Их пример документирования подразумевает, что они специально не вызывают кваргов. (other_silly_variable = Нет)
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-B-B есть вопрос о принятом ответе на ссылку на документацию по управлению подпроцессом. Если вы импортируете модуль, вы можете быстро просмотреть строки документации модуля через inspect.getsource.
Пример из интерпретатора Python, использующего рекомендацию Silent Ghost:
>>> import subprocess
>>> import inspect
>>> import print inspect.getsource(subprocess)
Конечно, вы также можете просмотреть документацию модуля через функцию справки. Например, справка (подпроцесс)
Лично я не являюсь поклонником строки документации подпроцесса для kwargs в качестве примера, но, как и в примере с Google, в нем нет отдельного списка kwargs, как показано в примере документации 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()
Я включил этот ответ на вопрос A-B-B, потому что стоит отметить, что вы можете просмотреть исходный код или документацию любого модуля таким образом, чтобы узнать и вдохновить комментировать ваш код.