feature: warn for type alias without docstring

Open AntoineD opened this issue 1 year ago • 2 comments

Is your feature request related to a problem? Please describe.

Where used, type aliases without docstring are rendered with no link to their definition.

Describe the solution you'd like

Issue a warning when a symbol refers to a type alias with no docstring such that is can be identified.

Mar 03 '24 14:03 AntoineD

Can you elaborate with examples/snippets/screenshots? I'm not sure to fully understand.

Mar 04 '24 11:03 pawamoy

I believe it's linters territory: warning users that a public object does not have a docstring. But since mkdocstrings works with docstrings, maybe we could consider adding such a check. This will have to wait for Griffe to have proper warning configuration options :slightly_smiling_face:

Apr 19 '24 14:04 pawamoy