Skip to content

Support "Yields" in docstrings #324

@nina-j

Description

@nina-j

Is your feature request related to a problem? Please describe.
Per the Google styleguide, the keyword Yields is used for generators. However, when using Yields in a docstring, it is not parsed by mkdocstrings:

image

Describe the solution you'd like
I'd like Yields to be parsed in the same manner that Returns is. :)

Metadata

Metadata

Assignees

No one assigned

    Labels

    featureNew feature or request

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions