在docstring sphinx中添加字典键

Question

为字典的键添加文档字符串的推荐方法是什么？我正在使用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编辑器似乎无法识别上述实现

编辑：我也读过this post，但答案没有提到如何指定键的“名称”

Answer 1

我通常会选择numpy style。根据我的个人经验，我相信这是SciPy / NumPy / pandas生态系统中常用的文档字符串样式。对于上述功能，您可以编写如下内容。

def my_func(my_dict):
    """
    Parameters
    ----------
    my_dict : dict
        dict of {str: int}.
    """
    pass

请参阅pandas docstring guide以供参考。