Skip to content

Coding guidelines concerning the API#14555

Merged
timhoffm merged 1 commit intomatplotlib:masterfrom
timhoffm:contributing-api
Jun 27, 2019
Merged

Coding guidelines concerning the API#14555
timhoffm merged 1 commit intomatplotlib:masterfrom
timhoffm:contributing-api

Conversation

@timhoffm
Copy link
Copy Markdown
Member

PR Summary

Alternative proposal to #14545, as discussed therein.

Comment thread doc/devel/contributing.rst Outdated
`MatplotlibDeprecationWarning`. There are a number of helper tools for this:

- Use `.cbook.warn_deprecated()` for general deprecation warnings.
- Use the decorator ``@cbook.warn_deprecated`` to deprecate whole functions.
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

cbook.deprecated
to deprecate classes, functions, methods, or properties.

Comment thread doc/devel/contributing.rst Outdated
`MatplotlibDeprecationWarning`. There are a number of helper tools for this:

- Use `.cbook.warn_deprecated()` for general deprecation warnings.
- Use the decorator ``@cbook.warn_deprecated`` to deprecate classes,
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@cbook.deprecated :)

Copy link
Copy Markdown
Contributor

@anntzer anntzer left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Just one typo, but anyone can merged after it is fixed and CI passes.

@timhoffm timhoffm merged commit db06a34 into matplotlib:master Jun 27, 2019
@timhoffm timhoffm deleted the contributing-api branch June 27, 2019 01:56
@QuLogic QuLogic added this to the v3.2.0 milestone Jun 27, 2019
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants