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
Some time ago we updated our Numpydoc-style docstring parser to improve its compliance with the official style guide, which does not explicitly allow prose in between or after known sections.
Admonitions like !!! info are prose (Markdown markup), and therefore are not supported anymore after known sections like Parameters, etc..
Instead, please use the style-specific support for admonitions:
deffoo(x: float) ->float:
"""Foo function. Note ---- This works. Parameters ---------- x : float Number Returns ------- float Square of number. Note ---- This works too. """returnx**2
Description of the bug
To Reproduce
The doc of
foo
in the example below shows the problemFull traceback
Expected behavior
Annotations placed after the parameters section should also work (they used to!).
Environment information
The text was updated successfully, but these errors were encountered: