Fix validate_markevery docstring markup. #21053
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
Make type lists fit in a single line. A strict reading suggests that all types should be separated with ` or ` rather than a comma, but avoiding a backslash continuation seems more useful. Also, *s* can also be a str.
timhoffm
approved these changes
Sep 12, 2021
meeseeksmachine
pushed a commit
to meeseeksmachine/matplotlib
that referenced
this pull request
Sep 12, 2021
timhoffm
added a commit
that referenced
this pull request
Sep 12, 2021
…053-on-v3.5.x Backport PR #21053 on branch v3.5.x (Fix validate_markevery docstring markup.)
tacaswell
pushed a commit
that referenced
this pull request
Oct 20, 2021
Fix validate_markevery docstring markup.
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.
Make type lists fit in a single line. A strict reading suggests that
all types should be separated with
orrather than a comma, butavoiding a backslash continuation seems more useful.
Also, s can also be a str.
(Old (incorrect) rendering: https://matplotlib.org/devdocs/api/rcsetup_api.html#matplotlib.rcsetup.validate_markevery)
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).