Repository navigation
bug: merge_init_into_class does not merge overloads #212
Description
Description of the bug
When using merge_init_into_class, signature overloads (typing.overload) are not merged into the class' docs.
To Reproduce
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| merge_init_into_class: true | merge_init_into_class: false |
|---|---|
 |
 |
WRITE MRE / INSTRUCTIONS HERE
Expected behavior
The overload defs should also be rendered.
Environment information
griffe --debug-info # | xclip -selection clipboard- System: macOS-14.7.1-x86_64-i386-64bit
- Python: cpython 3.12.7 (/usr/local/Caskroom/miniconda/base/envs/medconb-client/bin/python3.12)
- Environment variables:
- Installed packages:
griffev1.5.1
Activity
pawamoy commentedon Nov 26, 2024
Thanks for the report @kaktus42. Even though we could consider it a new feature, the behavior doesn't match what the user can expect, so I'll mark this as a bug.
Here is how I see things could be rendered:
This will bring rudimentary support for such cases. We have other issues in our backlog to improve support for overloads.
pawamoy commentedon Dec 3, 2024
Here's how it will look.
fix: Handle `__init__` overloads when merging into class
fix: Handle `__init__` overloads when merging into class