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
If this is intentional, then we should update the wording of the style guide to make it more clear. I'm pretty sure this is a mismatch though, so I have opened gh-571 to change the orders in docscrape.
Cool, if there aren't any counterarguments after a few days I'll modify the test such that Attributes and Methods are located below Parameters and above Returns.
https://numpydoc.readthedocs.io/en/latest/format.html#class-docstring states that the Attributes section should be "located below the Parameters section". In practice,
docscrape
works with the order:This seems deliberate, as
numpydoc/numpydoc/tests/test_docscrape.py
Line 1258 in 54dbc89
tests that Examples comes above Attributes and Methods.
However, this seems to create some weird doc pages, like https://scipy.github.io/devdocs/reference/generated/scipy.interpolate.CubicHermiteSpline.html. Is it really intentional that Attributes and Methods come below References and Notes? When reading the style guide, I interpret it as immediately below the Parameters section, which seems to make intuitive sense.
If this is intentional, then we should update the wording of the style guide to make it more clear. I'm pretty sure this is a mismatch though, so I have opened gh-571 to change the orders in
docscrape
.x-ref scipy/scipy#21099
The text was updated successfully, but these errors were encountered: