Move pylab documentation to its own module page #26396
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
jklymak
approved these changes
Jul 26, 2023
story645
reviewed
Jul 26, 2023
lib/matplotlib/pylab.py
Outdated
| The wildcard import will overwrite some builtin functions (e.g. the builtin `sum` | ||
| will be replaced by `numpy.sum`). This can lead to unexpected behavior. | ||
|
|
||
| The use of pylab is strongly discouraged. Use `matplotlib.pyplot` instead. |
There was a problem hiding this comment.
Put as part of the first sentence - if they're looking for pyplot they'll just go there instead.
Previously, pylab was not listed under modules, but the module docstring (and thus also the target of pylab links) wa on the API Reference top page. While pylab is discouraged, it's still a regular module and should be handled as such. Even more importantly, by removing the pylab section from the API reference top page, we de-emphasize it. Note, that pylab is still mentioned in the more in-depth backend discussion at https://matplotlib.org/devdocs/users/explain/figure/api_interfaces.html Co-authored-by: hannah <story645@gmail.com> Co-authored-by: Jody Klymak <jklymak@gmail.com>
|
Thanks for the reviews, I've rephrased the whole docstring, an in there tried to take your comments into account. |
story645
approved these changes
Jul 27, 2023
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.
Previously, pylab was not listed under modules, but the module docstring (and thus also the target of pylab links) was on the API Reference top page.
While pylab is discouraged, it's still a regular module and should be handled as such. Even more importantly, by removing the pylab section from the API reference top page, we de-emphasize it. Note, that pylab is still mentioned in the more in-depth backend discussion at https://matplotlib.org/devdocs/users/explain/figure/api_interfaces.html