Generalize validation that pyplot commands are documented #24000
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
2c0f960 to
37bd152
Compare
37bd152 to
009bfab
Compare
story645
reviewed
Sep 25, 2022
| ``matplotlib.pyplot.get_plot_commands`` | ||
| ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ | ||
|
|
||
| ... is pending to be deprecated. This is considered internal and no end-user |
There was a problem hiding this comment.
Suggested change
| ... is pending to be deprecated. This is considered internal and no end-user | |
| ... pending deprecation. This is considered internal and no end-user |
There was a problem hiding this comment.
... is a pending deprecation is another option, but the construction pending to be reads super off to me
There was a problem hiding this comment.
Yes, 'pending' is a state (i.e., an adjective), not a verb. I guess 'pend' is apparently a verb, but it's not used with an object. So the deprecation may be pending, but you cannot 'pend a deprecation'.
It either 'is (in a state of) pending deprecation' or 'is a pending deprecation'.
QuLogic
approved these changes
Sep 27, 2022
story645
reviewed
Sep 28, 2022
9907a9b to
29f19e5
Compare
|
Uh I think something went wrong in the rebase 'cause I'm not seeing changes? |
|
Hm, will check later. |
29f19e5 to
aa9540a
Compare
|
@story645: fixed. |
|
Not as far as I can tell :/ |
timhoffm
commented
Sep 29, 2022
|
Rebased to fix CI. |
story645
approved these changes
Oct 16, 2022
Until now, the test made some exclusions (_NON_PLOT_COMMANDS) and reqired all functions to be documented in a single autosummary block. This change ensures the documentation of the _NON_PLOT_COMMANDS and it allows the commands to be spread across arbitrary many autosummary sections. This is in preparation of regrouping the pyplot commands similar to the Axes documentation. This also pending deprecates `pyplot.get_plot_commands`, which should not be a public function. I'm defensive by using pending, because if `get_plot_commands` is used somewhere, that's most likely some downstream lib and we want to give them time to adapt. Co-authored-by: hannah <[email protected]>
10 tasks
QuLogic
added a commit
to QuLogic/matplotlib
that referenced
this pull request
Mar 30, 2023
The typing PR found that this was returning a generator [1], but this was an error from matplotlib#24000, as 3.6 and earlier returned a list. [1] matplotlib#24976 (comment)
Higgs32584
pushed a commit
to Higgs32584/matplotlib
that referenced
this pull request
Apr 17, 2023
The typing PR found that this was returning a generator [1], but this was an error from matplotlib#24000, as 3.6 and earlier returned a list. [1] matplotlib#24976 (comment)
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Until now, the test made some exclusions (_NON_PLOT_COMMANDS) and reqired all functions to be documented in a single autosummary block.
This change ensures the documentation of the _NON_PLOT_COMMANDS and it allows the commands to be spread across arbitrary many autosummary sections. This is in preparation of regrouping the pyplot commands similar to the Axes documentation.
This also pending deprecates
pyplot.get_plot_commands, which should not be a public function. I'm defensive by using pending, because ifget_plot_commandsis used somewhere, that's most likely some downstream lib and we want to give them time to adapt.Correctness of this change is automatically tested by by passing
test_pyplot.py::test_doc_pyplot_summary.