Я пытаюсь задокументировать возвращаемое значение кортежа, используя пустой формат строки документа, но не могу заставить его работать с подсказками типа pycharm.
Я пробовал несколько способов, и даже нашел один, который работал для типа, но не позволил мне добавить описание для каждого из его элементов.
Пример функции для документирования:
def function():
foo = 42
bar = {
example : 1337,
dictionary : 46,
}
return foo, bar
Теперь, один из способов документировать это:
def function():
"""
This is the function summary.
Returns
-------
foobar : tuple[int,[dict[string, int]]
This is a description of the return type
"""
foo = 42
bar = {
'example' : 1337,
'dictionary' : 46,
}
return foo, bar
Это дало бы мне описание и подсказку правильного типа возвращаемого значения, но не отдельные описания для каждого элемента, которые я хотел бы.
Вот нерабочий пример того, чего я пытаюсь достичь:
def function():
"""
This is the function summary.
Returns
-------
foo : int
This is an int
bar : [dict[string, int]
This is a dictionary
"""
foo = 42
bar = {
'example' : 1337,
'dictionary' : 46,
}
return foo, bar