Docstring cleanups around DATA_PARAMETER_PLACEHOLDER. #21140
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
- `[notes section required to get data note injection right]` has been obsoleted by DATA_PARAMETER_PLACEHOLDER; get rid of them. - loglog, semilogx, semilogy are thin wrappers around plot; it seems fine to not document data there and leave it implicitly part of `**kwargs: all parameters supported by plot`. Then "Other Parameters" only contains `**kwargs` whose description is quite short, so it can just be lifted into the main Parameters section rather than requiring a separate section just for itself. - Likewise for `step`, but that method actually explicitly lists `data` in its signature, so just move its (already existing) description down to its correct position. This change was motivated by the fact that DATA_PARAMETER_PLACEHOLDER is not correctly handled for these simple plot() wrappers; because they all operate without going through _preprocess_data(), fixing them would also require their own ad-hoc solution anyways.
jklymak
approved these changes
Sep 21, 2021
tacaswell
approved these changes
Sep 22, 2021
meeseeksmachine
pushed a commit
to meeseeksmachine/matplotlib
that referenced
this pull request
Sep 22, 2021
QuLogic
added a commit
that referenced
this pull request
Sep 23, 2021
…140-on-v3.5.x Backport PR #21140 on branch v3.5.x (Docstring cleanups around DATA_PARAMETER_PLACEHOLDER.)
tacaswell
added a commit
to tacaswell/matplotlib
that referenced
this pull request
Oct 12, 2021
DOC: Docstring cleanups around DATA_PARAMETER_PLACEHOLDER.
tacaswell
added a commit
that referenced
this pull request
Oct 20, 2021
DOC: Docstring cleanups around DATA_PARAMETER_PLACEHOLDER.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 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.
[notes section required to get data note injection right]has beenobsoleted by DATA_PARAMETER_PLACEHOLDER; get rid of them.
fine to not document data there and leave it implicitly part of
**kwargs: all parameters supported by plot. Then "Other Parameters"only contains
**kwargswhose description is quite short, so it canjust be lifted into the main Parameters section rather than requiring
a separate section just for itself.
step, but that method actually explicitly listsdatain its signature, so just move its (already existing) description down
to its correct position.
This change was motivated by the fact that DATA_PARAMETER_PLACEHOLDER is
not correctly handled for these simple plot() wrappers; because they all
operate without going through _preprocess_data(), fixing them would also
require their own ad-hoc solution anyways. (#21135)
PR Summary
PR Checklist
pytestpasses).flake8on changed files to check).flake8-docstringsand runflake8 --docstring-convention=all).doc/users/next_whats_new/(follow instructions in README.rst there).doc/api/next_api_changes/(follow instructions in README.rst there).