Skip to content

Class Attributes section in different place than documented #331

Closed
@QuLogic

Description

@QuLogic

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.

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions