在文檔字符串 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 編輯器似乎無法識別上面的實現

編輯：我也讀過這篇文章，但答案沒有提到如何指定鍵的“名稱”

Answer 1

我通常采用numpy 風格。 根據我的個人經驗，我認為這是 SciPy/NumPy/pandas 生態系統中常用的 docstring 樣式。 對於上面的函數，你可以這樣寫。

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

請參閱Pandas 文檔字符串指南以供參考。