Uh oh!
There was an error while loading.Please reload this page.
- Notifications
You must be signed in to change notification settings - Fork7.9k
Generalize validation that pyplot commands are documented#24000
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to ourterms of service andprivacy statement. We’ll occasionally send you account related emails.
Already on GitHub?Sign in to your account
Uh oh!
There was an error while loading.Please reload this page.
Conversation
| ``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.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others.Learn more.
| ...ispendingto be deprecated. This is considered internal and no end-user | |
| ... pendingdeprecation. This is considered internal and no end-user |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others.Learn more.
... is a pending deprecation is another option, but the constructionpending to be reads super off to me
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others.Learn more.
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'.
Uh oh!
There was an error while loading.Please reload this page.
Uh oh!
There was an error while loading.Please reload this page.
Uh I think something went wrong in the rebase 'cause I'm not seeing changes? |
Hm, will check later. |
@story645: fixed. |
story645 commentedSep 29, 2022 • edited
Loading Uh oh!
There was an error while loading.Please reload this page.
edited
Uh oh!
There was an error while loading.Please reload this page.
Not as far as I can tell :/ |
Uh oh!
There was an error while loading.Please reload this page.
Rebased to fix CI. |
story645 left a comment• edited
Loading Uh oh!
There was an error while loading.Please reload this page.
edited
Uh oh!
There was an error while loading.Please reload this page.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others.Learn more.
See discussion btw. Elliot and me on the grammar of pending but also like I'm not actually keen on holding up a PR 'cause of grammar (edit: can self merge w/ or w/o changing sentence)
Until now, the test made some exclusions (_NON_PLOT_COMMANDS) andreqired all functions to be documented in a single autosummary block.This change ensures the documentation of the _NON_PLOT_COMMANDSand it allows the commands to be spread across arbitrary manyautosummary sections. This is in preparation of regrouping the pyplotcommands similar to the Axes documentation.This also pending deprecates `pyplot.get_plot_commands`, which shouldnot be a public function. I'm defensive by using pending, because if`get_plot_commands` is used somewhere, that's most likely somedownstream lib and we want to give them time to adapt.Co-authored-by: hannah <story645@gmail.com>
The typing PR found that this was returning a generator [1], but thiswas an error frommatplotlib#24000, as 3.6 and earlier returned a list.[1]matplotlib#24976 (comment)
The typing PR found that this was returning a generator [1], but thiswas an error frommatplotlib#24000, as 3.6 and earlier returned a list.[1]matplotlib#24976 (comment)
Uh oh!
There was an error while loading.Please reload this page.
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.