Правильный способ документировать ключи в TypedDict? ⇐ Python

[Anonymous]

Как правильный способ документировать ключи внутри TypedDict ? Я не вижу много информации внутри PEP 589-TypedDict. < /P>
Я могу вспомнить несколько решений: < /p>

[*] Клавиши документов в Docstring (есть ли здесь стандартное поле для использования?)

Код: Выделить всё

class Foo(TypedDict):
"""
I am a documented schema.

Keys:
key: This key has some implications needing documentation.
"""

key: int

Клавиши документа с использованием встроенных комментариев внутри TypedDict
class Foo(TypedDict):
"""I am a documented schema."""

# This key has some implications needing documentation
key: int
< /code>
< /li>
< /ol>
Есть ли официальный подход к этому? Что -нибудь конкретное, что может искать сфинкс?


Подробнее здесь: https://stackoverflow.com/questions/741 ... -typeddict