<p><strong>Sphinx解析的谷歌风格文档字符串</p>
<p>免责声明:未经测试。</p>
<p>从<a href="http://sphinx-doc.org/latest/ext/example_google.html#example-google" rel="noreferrer">sphinx docstring example</a>的这个剪切中,<code>*args</code>和<code>**kwargs</code>未展开:</p>
<pre><code>def module_level_function(param1, param2=None, *args, **kwargs):
"""
...
Args:
param1 (int): The first parameter.
param2 (Optional[str]): The second parameter. Defaults to None.
Second line of description should be indented.
*args: Variable length argument list.
**kwargs: Arbitrary keyword arguments.
</code></pre>
<p>我建议用以下方法解决压实度问题:</p>
<pre><code> """
Args:
param1 (int): The first parameter.
param2 (Optional[str]): The second parameter. Defaults to None.
Second line of description should be indented.
*param3 (int): description
*param4 (str):
...
**key1 (int): description
**key2 (int): description
...
</code></pre>
<p>注意,<code>**key</code>参数不需要<code>Optional</code>。</p>
<p><strong>否则,可以尝试在<code>Other Parameters</code>下显式列出*参数,在<code>Keyword Args</code>下显式列出<code>**kwargs</code>(请参阅解析的<a href="http://sphinxcontrib-napoleon.readthedocs.org/en/latest/index.html#sections" rel="noreferrer">sections</a>):</p>
<pre><code> """
Args:
param1 (int): The first parameter.
param2 (Optional[str]): The second parameter. Defaults to None.
Second line of description should be indented.
Other Parameters:
param3 (int): description
param4 (str):
...
Keyword Args:
key1 (int): description
key2 (int): description
...
</code></pre>