types(docs[plugin]): Document config schema keys · tmux-python/tmuxp@b586083 · GitHub
Skip to content

Commit b586083

Browse files
committed
types(docs[plugin]): Document config schema keys
why: Autodoc renders TypedDict keys whether or not they are described, so the plugin config schema shipped to the API reference with bare entries and no explanation of what each version bound controls. what: - Add a summary and Attributes section to PluginConfigSchema - Describe each key, including how omitted keys are filled from the plugin defaults and what the incompatible lists exclude
1 parent 4a9f6b4 commit b586083

1 file changed

Lines changed: 34 additions & 0 deletions

File tree

‎src/tmuxp/_internal/types.py‎

Lines changed: 34 additions & 0 deletions

0 commit comments

Comments
 (0)