Coding guidelines concerning the API #14555
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
timhoffm
force-pushed
the
contributing-api
branch
from
1c1dc21 to
c364256
Compare
6 tasks
anntzer
reviewed
Jun 15, 2019
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. |
Contributor
There was a problem hiding this comment.
cbook.deprecated
to deprecate classes, functions, methods, or properties.
timhoffm
force-pushed
the
contributing-api
branch
from
c364256 to
31ecc0c
Compare
anntzer
reviewed
Jun 20, 2019
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, |
anntzer
approved these changes
Jun 20, 2019
Contributor
anntzer
left a comment
anntzer
left a comment
There was a problem hiding this comment.
Just one typo, but anyone can merged after it is fixed and CI passes.
dstansby
approved these changes
Jun 25, 2019
timhoffm
force-pushed
the
contributing-api
branch
from
31ecc0c to
2aba578
Compare
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
4 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
PR Summary
Alternative proposal to #14545, as discussed therein.