Skip to content

feature: warn for type alias without docstring #138

Open
@AntoineD

Description

@AntoineD

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.

Activity

pawamoy

pawamoy commented on Mar 4, 2024

@pawamoy
Member

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

pawamoy

pawamoy commented on Apr 19, 2024

@pawamoy
Member

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 🙂

removed
fundIssue priority can be boosted
on Mar 2, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

Labels

Type

No type

Projects

No projects

Milestone

No milestone

Relationships

None yet

    Development

    No branches or pull requests

      Participants

      @AntoineD@pawamoy

      Issue actions

        feature: warn for type alias without docstring · Issue #138 · mkdocstrings/python