Skip to content

use the sphinx directives for deprecated warning #2639

Closed
@wyli

Description

@wyli

Is your feature request related to a problem? Please describe.
part of the feature request #233,
the relevant docstrings should include details for

  • versionadded
  • versionchanged
  • deprecated

according to
https://www.sphinx-doc.org/en/master/usage/restructuredtext/directives.html#directive-versionadded

the contributing guide should be updated to recommend the usage.

Metadata

Metadata

Assignees

No one assigned

    Labels

    enhancementNew feature or request

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions