[DOC]: make spanselector example codeblock continuous #24037
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
story645
approved these changes
Sep 28, 2022
|
Since it's at the top now, it's better to move it into the docstring instead of as a separate comment. |
|
I like it as the note cause I figure then it's more likely to get read. |
|
The note can still be part of the docstring. |
timhoffm
approved these changes
Sep 29, 2022
meeseeksmachine
pushed a commit
to meeseeksmachine/matplotlib
that referenced
this pull request
Sep 29, 2022
timhoffm
added a commit
that referenced
this pull request
Sep 29, 2022
…037-on-v3.6.x Backport PR #24037 on branch v3.6.x ([DOC]: make spanselector example codeblock continuous)
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
The spanselector example currently has the code broken up into two chunks by a plot. This is confusing because it's easy to copy the first block without the second and then get confused why it doesn't work (like just happened to me). I think that this will make the codeblock continuous so it's easier to copy and not get confused.
PR Checklist
Tests and Styling
pytestpasses).flake8-docstringsand runflake8 --docstring-convention=all).Documentation
doc/users/next_whats_new/(follow instructions in README.rst there).doc/api/next_api_changes/(follow instructions in README.rst there).