Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feature: warn for type alias without docstring #138

Open
AntoineD opened this issue Mar 3, 2024 · 2 comments
Open

feature: warn for type alias without docstring #138

AntoineD opened this issue Mar 3, 2024 · 2 comments
Assignees
Labels
extractor: griffe Related to griffe feature New feature or request griffe extension Can be solved with a Griffe extension

Comments

@AntoineD
Copy link
Contributor

AntoineD commented Mar 3, 2024

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.

@pawamoy
Copy link
Member

pawamoy commented Mar 4, 2024

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

@pawamoy pawamoy added the feature New feature or request label Apr 13, 2024
@pawamoy
Copy link
Member

pawamoy commented Apr 19, 2024

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 🙂

@pawamoy pawamoy added extractor: griffe Related to griffe griffe extension Can be solved with a Griffe extension labels Apr 19, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
extractor: griffe Related to griffe feature New feature or request griffe extension Can be solved with a Griffe extension
Projects
None yet
Development

No branches or pull requests

2 participants