We read every piece of feedback, and take your input very seriously.
To see all available qualifiers, see our documentation.
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
When using merge_init_into_class, signature overloads (typing.overload) are not merged into the class' docs.
merge_init_into_class
Example:
from typing import overload class Foo: """ Foo class docs """ @overload def __init__(self, *, a: str): ... @overload def __init__(self, *, b: str): ... def __init__(self, **kwargs): """ Foo constructor docs """ pass
WRITE MRE / INSTRUCTIONS HERE
The overload defs should also be rendered.
griffe --debug-info # | xclip -selection clipboard
griffe
The text was updated successfully, but these errors were encountered:
pawamoy
No branches or pull requests
Description of the bug
When using
merge_init_into_class
, signature overloads (typing.overload) are not merged into the class' docs.To Reproduce
Example:
Expected behavior
The overload defs should also be rendered.
Environment information
griffe --debug-info # | xclip -selection clipboard
griffe
v1.5.1Additional context
The text was updated successfully, but these errors were encountered: