FazBrowse GitHub Viewer | Trending |
URL:
| Home
Tools: [Download Repo ZIP]   [Original HTTPS Page]

[DOC]: make spanselector example codeblock continuous by ianhi · Pull Request #24037 · matplotlib/matplotlib · GitHub

Repository navigation

[DOC]: make spanselector example codeblock continuous - #24037

Merged
timhoffm merged 2 commits into
matplotlib:mainfrom
ianhi:span-example
Sep 29, 2022
Merged

timhoffm merged 2 commits into
matplotlib:mainfrom
ianhi:span-example

Conversation

ianhi commented Sep 28, 2022

Copy link
Copy Markdown
Contributor

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

  • [NA] Has pytest style unit tests (and pytest passes).
  • [NA] Is Flake 8 compliant (install flake8-docstrings and run flake8 --docstring-convention=all).

Documentation

  • [NA] New features are documented, with examples if plot related.
  • [NA] New features have an entry in doc/users/next_whats_new/ (follow instructions in README.rst there).
  • [NA] API changes documented in doc/api/next_api_changes/ (follow instructions in README.rst there).
  • [?] Documentation is sphinx and numpydoc compliant (the docs should build without error).

ianhi changed the title [DOC]: make spanselector codeblock continuous [DOC]: make spanselector example codeblock continuous Sep 28, 2022
story645 added this to the v3.6-doc milestone Sep 28, 2022

ianhi commented Sep 28, 2022

Copy link
Copy Markdown
Contributor Author

QuLogic commented Sep 28, 2022

Copy link
Copy Markdown
Member

Since it's at the top now, it's better to move it into the docstring instead of as a separate comment.

Copy link
Copy Markdown
Member

I like it as the note cause I figure then it's more likely to get read.

Copy link
Copy Markdown
Member

The note can still be part of the docstring.

story645 modified the milestones: v3.6-doc, v3.6.1, v3.6.2 Sep 29, 2022
timhoffm merged commit 7a25f50 into matplotlib:main Sep 29, 2022
meeseeksmachine pushed a commit to meeseeksmachine/matplotlib that referenced this pull request Sep 29, 2022
ianhi deleted the span-example branch September 29, 2022 16:49
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)
ksunden mentioned this pull request Feb 20, 2023
6 tasks
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
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants


Back | FazBrowse Home | New Git URL