DOC: Minor improvements on quickstart #28134
Merged
Conversation
This file contains 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
That ``` import matplotlib as mpl mpl.[submodule].[class] ``` works is an implementation detail because the top-level namespace has imported these submodules. There's no guarantee this will continue to work. Also move the imports of the two relevant classes close to their usage. This minimizes our top-level import to the canonical `import matplotlib.pyplot as plt`.
- Add `plt.show()` to first example and explain that it may be
omitted sometimes rather than not having it in the code and
stating that it has to be added sometimes.
Reason: a missing show may result in no figure popup and is
hard to debug. An extraneous show has no effect.
- Figure creation functions:
- de-emphasize pyplot. Stating the functions is enough here.
We don't need to say where they come from explicitly. In
particular we haven't explained the interface distinction yet.
So let's be quite about that.
- Do not mention/link backends here. That concept is far too
advanced and not need here.
- Some more wording changes.
github-actions
bot
added
the
Documentation: user guide
QuLogic
approved these changes
Apr 24, 2024
Co-authored-by: Elliott Sales de Andrade <quantum.analyst@gmail.com>
meeseeksmachine
pushed a commit
to meeseeksmachine/matplotlib
that referenced
this pull request
Apr 25, 2024
timhoffm
added a commit
that referenced
this pull request
Apr 25, 2024
…134-on-v3.9.x Backport PR #28134 on branch v3.9.x (DOC: Minor improvements on quickstart)
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.
See the commit messages.
Commits are best be looked at individually.