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 class docstring section says to use the same sections as "above", meaning as in functions, and that "An Attributes section, located below the Parameters section, may be used to describe non-method attributes of the class". When this is rendered the Parameters and Attributes sections are separated by Notes, References, and Examples.
Now, the class docstring docs don't say that Attributes must immediately after Parameters, but ordering has always been important (#68), and having HTML docs be in a different order than in-code can make writing them confusing.
The text was updated successfully, but these errors were encountered:
which implicitly depends on Notes being placed after Parameters, because it makes a relative reference in the notes ala "the above attributes". I've submitted a PR downstream (scipy/scipy#14693) for this specific instance, but it feels a bit like treating symptoms 😄
Could we move the Attributes section to immediately follow Parameters like @QuLogic suggested?
The class docstring section says to use the same sections as "above", meaning as in functions, and that "An Attributes section, located below the Parameters section, may be used to describe non-method attributes of the class". When this is rendered the
Parameters
andAttributes
sections are separated byNotes
,References
, andExamples
.Now, the class docstring docs don't say that
Attributes
must immediately afterParameters
, but ordering has always been important (#68), and having HTML docs be in a different order than in-code can make writing them confusing.The text was updated successfully, but these errors were encountered: