You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
The mkdocstrings Python handler is able to merge __init__ methods docstrings into their classes' docstrings.
This is nice, but usually __init__ methods just have a summary like "Initialize this [CLASS]." which simply breaks the flow of the merged docstring, especially since it's usually followed by a Parameters section.
This option allows to ignore the summary (while keeping the correct line number in parsing warnings).
The mkdocstrings Python handler is able to merge
__init__
methods docstrings into their classes' docstrings.This is nice, but usually
__init__
methods just have a summary like "Initialize this [CLASS]." which simply breaks the flow of the merged docstring, especially since it's usually followed by a Parameters section.This option allows to ignore the summary (while keeping the correct line number in parsing warnings).
griffe/src/griffe/docstrings/google.py
Lines 522 to 534 in 81f0333
The text was updated successfully, but these errors were encountered: