Какой рекомендуемый способ добавления строки документации для параметра словаря? Я могу увидеть несколько строк документации здесь.
Мне нужно документировать входные аргументы функции в строке документации. Если это простая переменная, я могу использовать что-то вроде:
def func2(a=x, b = y):
""" fun2 takes two integers
Keyword arguments:
a -- refers to age (default 18)
b -- refers to experience (default 0)
"""
Если мы передали dict
качестве входного аргумента функции:
def func3(**kwargs):
""" takes dictionary as input
<Here how to explain them - Is it like?>
kwargs['key1'] -- takes value1
<or simply>
key1 -- takes value1
"""