Добавьте словарные ключи в docstring sphinx - PullRequest
1 голос
/ 08 марта 2019

Каков рекомендуемый способ добавления строки документации для ключей словаря? Я использую Python 2.7 и Sphinx.

Например, в следующем коде, как я должен упомянуть ключи 'a' и 'b' для my_dict? (Но, может быть, не стоит вдаваться в такие подробности):

def my_func(my_dict):
    """
    :param dict {'a': float, 'b': str} my_dict: description of param
    """
    pass

Реализация выше, кажется, не распознается моим редактором Pycharm

РЕДАКТИРОВАТЬ: я также прочитал этот пост , но в ответе не упоминается, как указать «имена» клавиш

...