Skip to content

Commit

Permalink
fix: Parse Deprecated sections in Google-style docstrings
Browse files Browse the repository at this point in the history
The code to parse these sections already existed, but the "Deprecated"
section header was missing from the table of known section headers.
Being an unknown section, Griffe then treated this as an admonition.

Issue-352: #352
  • Loading branch information
the-13th-letter committed Jan 16, 2025
1 parent 3cf96c5 commit 259a8fe
Showing 1 changed file with 1 addition and 0 deletions.
1 change: 1 addition & 0 deletions src/_griffe/docstrings/google.py
Original file line number Diff line number Diff line change
Expand Up @@ -69,6 +69,7 @@
"modules": DocstringSectionKind.modules,
"warns": DocstringSectionKind.warns,
"warnings": DocstringSectionKind.warns,
"deprecated": DocstringSectionKind.deprecated,
}

_BlockItem = tuple[int, list[str]]
Expand Down

0 comments on commit 259a8fe

Please sign in to comment.