feature: Warn about attributes sections found in __init__
method docstrings
#144
Labels
extractor: griffe
Related to griffe
feature
New feature or request
griffe extension
Can be solved with a Griffe extension
Description of the bug
If attributes are documented in the
__init__
method (see class below), their types are missing after rendering (see the screenshot).screenshot
![image](https://private-user-images.githubusercontent.com/9798985/317351261-54efd1a6-496f-4c69-b2f3-e5df4045152a.png?jwt=eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpc3MiOiJnaXRodWIuY29tIiwiYXVkIjoicmF3LmdpdGh1YnVzZXJjb250ZW50LmNvbSIsImtleSI6ImtleTUiLCJleHAiOjE3MjAzMjA4MDYsIm5iZiI6MTcyMDMyMDUwNiwicGF0aCI6Ii85Nzk4OTg1LzMxNzM1MTI2MS01NGVmZDFhNi00OTZmLTRjNjktYjJmMy1lNWRmNDA0NTE1MmEucG5nP1gtQW16LUFsZ29yaXRobT1BV1M0LUhNQUMtU0hBMjU2JlgtQW16LUNyZWRlbnRpYWw9QUtJQVZDT0RZTFNBNTNQUUs0WkElMkYyMDI0MDcwNyUyRnVzLWVhc3QtMSUyRnMzJTJGYXdzNF9yZXF1ZXN0JlgtQW16LURhdGU9MjAyNDA3MDdUMDI0ODI2WiZYLUFtei1FeHBpcmVzPTMwMCZYLUFtei1TaWduYXR1cmU9NDY1MmRiYWNmYWRiOTA3MzE1NzY0Y2M3ODIwNjIxNTZiOWRkNmNiZWYwMzhhODVjYTNjMTk5MzA0ODA5OWQzZCZYLUFtei1TaWduZWRIZWFkZXJzPWhvc3QmYWN0b3JfaWQ9MCZrZXlfaWQ9MCZyZXBvX2lkPTAifQ.-L9XZLX46hc-OlIIIawko2sXvzJAK69iXDqfMu1tAOU)
To Reproduce
Full traceback
Full traceback
Expected behavior
Not matter where attributes are documented (module level, class level or
__init__
method), their types should be extracted and rendered properly.Environment information
python -m mkdocstrings_handlers.python.debug # | xclip -selection clipboard
mkdocs
v1.5.3mkdocstrings
v0.24.1mkdocstrings-python
v1.9.0griffe
v0.42.0Additional context
mkdocs.yml
The text was updated successfully, but these errors were encountered: