[英]how to correctly add nested list in numpy docstring in combination with sphinx docstring
[英]Add dictionary keys in docstring sphinx
为字典的键添加文档字符串的推荐方法是什么? 我正在使用 python 2.7 和 Sphinx。
例如,在下面的代码中,我应该如何提及 my_dict 的键“a”和“b”? (但也许没有必要详细介绍):
def my_func(my_dict):
"""
:param dict {'a': float, 'b': str} my_dict: description of param
"""
pass
我的 Pycharm 编辑器似乎无法识别上面的实现
编辑:我也读过这篇文章,但答案没有提到如何指定键的“名称”
我通常采用numpy 风格。 根据我的个人经验,我认为这是 SciPy/NumPy/pandas 生态系统中常用的 docstring 样式。 对于上面的函数,你可以这样写。
def my_func(my_dict):
"""
Parameters
----------
my_dict : dict
dict of {str: int}.
"""
pass
请参阅Pandas 文档字符串指南以供参考。
声明:本站的技术帖子网页,遵循CC BY-SA 4.0协议,如果您需要转载,请注明本站网址或者原文地址。任何问题请咨询:yoyou2525@163.com.