Fix some minor docstring typos #24282
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
oscargus
reviewed
Oct 26, 2022
lib/matplotlib/widgets.py
Outdated
| >>> fig.show() | ||
|
|
||
| >>> selector.add_state('square') | ||
| >>> |
There was a problem hiding this comment.
I suspected the extra line was there to emphasize it, but I'm not sure.
There was a problem hiding this comment.
It starts a new box, so probably, yes. I'm more wondering about the rationale to put an empty command-line/return-press instead. Better to drop it completely then?
343b013 to
13438f8
Compare
ksunden
approved these changes
Nov 1, 2022
timhoffm
approved these changes
Nov 1, 2022
meeseeksmachine
pushed a commit
to meeseeksmachine/matplotlib
that referenced
this pull request
Nov 1, 2022
tacaswell
added a commit
that referenced
this pull request
Nov 1, 2022
…282-on-v3.6.x Backport PR #24282 on branch v3.6.x (Fix some minor docstring typos)
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.
PR Summary
Found while testing out
flake8-rst(for which there are unfortunately a few too many false positives.)PR Checklist
Tests and Styling
pytestpasses).flake8-docstringsand runflake8 --docstring-convention=all).Documentation
Release Notes
.. versionadded::directive in the docstring and documented indoc/users/next_whats_new/.. versionchanged::directive in the docstring and documented indoc/api/next_api_changes/next_whats_new/README.rstornext_api_changes/README.rst