Skip to content

Use help parameter for traits rather than setting __doc__ #2844

@dopplershift

Description

@dopplershift

Currently all the traits in the simplified plotting interface are documented by setting the __doc__ attribute. Traits have a help parameter in the constructor that we can use instead, and with traitlets 5.8.0, this now maps to the __doc__ attribute.

We should update, though we should check on whether there are other impacts of this beyond just building our docs (e.g. in jupyter environments). If there are jupyter ramifications, we probably want to wait a bit before making 5.8.0 our minimum version.

Metadata

Metadata

Assignees

No one assigned

    Labels

    Area: DocsAffects documentationType: MaintenanceUpdates and clean ups (but not wrong)good first issueStraightforward issues suitable for new and inexperienced contributors to the project

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions