记录**kwargs参数的正确方法是什么?

我正在使用Sphinx和autodoc扩展为Python模块生成API文档。虽然我知道如何很好地记录特定参数,但我找不到如何记录**kwargs参数的示例

有没有人有一个清晰的方法来记录这些内容的好例子

找到这个问题后,我解决了以下问题,这是有效的斯芬克斯,效果相当好:

定义一些函数(第一个,第二个=“两个”**kwargs):
r“”获取并返回此对象
:参数优先:
第一个参数
:首先键入:`int``
:参数秒:
第二个参数
:键入第二个:``str``
:param\**kwargs:
见下文
:关键字参数:
**额外*(`list``)--
额外的东西
**补编*(`dict``)--
附加内容
"""

r”““…”需要使其成为一个“原始”文档字符串,从而保持\*的完整性(Sphinx以文本形式拾取*,而不是“强调”的开头)

所选择的格式(带括号类型的项目符号列表和m-破折号分隔的描述)只是为了匹配Sphinx提供的自动格式

一旦你努力使“关键字参数”部分看起来像默认的“参数”部分,从一开始就滚动你自己的参数部分似乎更容易(根据其他一些答案),但是,作为概念证明,如果您已经在使用Sphinx,这是一种为补充的**kwargs实现漂亮外观的方法

发表评论