Closed machow closed 5 months ago
Definitely looks like a bug in the parser! Also, yeah, I was planning to add support for generic admonitions, just like in the Google parser.
I can work on a quick PR tomorrow for the numpydoc parser! Is DocstringSectionAdmonition the catch-all for unknown sections? I think because I focused initially on numpydoc format in quartodoc, I totally missed that this piece existed in the google style parser 😅
(guessing from this google parser line)
Is DocstringSectionAdmonition the catch-all for unknown sections?
Yes!
A PR would be awesome, thanks a lot :)
Describe the bug
For a function with a docstring like this:
griffe's numpydoc parses produces a single DocstringSectionText, with all the contents.
WDYT of editing this line of the numpydoc parse, to ensure any section marked with lines (
----
) is its own DocstringSectionText?https://github.com/mkdocstrings/griffe/blob/main/src/griffe/docstrings/numpy.py#L816
This way, various sections like See Also will be in their own DocstringSectionText, regardless of whether they're...