Python 在docstring sphinx中添加字典键

为字典的键添加docstring的推荐方法是什么？我正在使用Python2.7和Sphinx

例如，在下面的代码中，我应该如何为我的字典提到键“a”和“b”？（但可能没有必要详述这些细节）：

我的Pycharm编辑器似乎无法识别上面的实现

编辑：我也读了，但答案没有提到如何指定我通常使用的键的“名称”。根据我个人的经验，我相信这是SciPy/NumPy/pandas生态系统中使用的一种常见的docstring样式。对于上面的函数，您可以编写如下内容

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

---

请参阅以获取参考。

问题的可能重复之处在于询问重新构造的文本表单docstring，既不是google样式，也不是NumPy样式。

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