Thanks to visit codestin.com
Credit goes to github.com

Skip to content

Remove "Use show()" from how-to #19867

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Apr 6, 2021
Merged

Conversation

timhoffm
Copy link
Member

@timhoffm timhoffm commented Apr 4, 2021

and move relevant content to show() docstring instead.

  • "call once per skipt" is outdated --> removed.
  • Relation to savefig() moved (and expanded).
  • Interactive mode is linked in show() and does not need a detailed discussion here.
  • Added a section on auto-show in jupyter notebooks.


Notes
-----
**Saving figures only to file**
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Numpydoc does not support subsections. I use an all-bold paragraph as a workaround. This is already used in other docstrings. See e.g. plot().

Comment on lines -318 to -323
In non-interactive mode, *block* defaults to True. All figures
will display and show will not return until all windows are closed.
If there are no figures, return immediately.

In interactive mode *block* defaults to False. This will ensure
that all of the figures are shown and this function immediately returns.
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Description of block defaults moved into parameter description.

@timhoffm timhoffm added this to the v3.4.2 milestone Apr 4, 2021
@tacaswell tacaswell merged commit 07fd38f into matplotlib:master Apr 6, 2021
meeseeksmachine pushed a commit to meeseeksmachine/matplotlib that referenced this pull request Apr 6, 2021
QuLogic added a commit that referenced this pull request Apr 6, 2021
…867-on-v3.4.x

Backport PR #19867 on branch v3.4.x (Remove "Use show()" from how-to )
@timhoffm timhoffm deleted the doc-show branch April 6, 2021 05:42
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.

2 participants