Rework pylab docstring. #16439
Merged
Rework pylab docstring. #16439
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
The old pylab module docstring was not rendered anywhere in the html docs (it was only visible with pydoc or with IPython's `pylab?`), and is outdated (e.g. it doesn't even list viridis as colormap). Instead of trying to list the functions provided, replace the docstring by the warning discouraging the use of pylab, and use that as entry in the html docs.
anntzer
approved these changes
Feb 8, 2020
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.
The old pylab module docstring was not rendered anywhere in the html
docs (it was only visible with pydoc or with IPython's
pylab?), and isoutdated (e.g. it doesn't even list viridis as colormap).
Instead of trying to list the functions provided, replace the docstring
by the warning discouraging the use of pylab, and use that as entry in
the html docs.
This replaces #16437 which was reverted due to https://discourse.matplotlib.org/t/removed-commits-from-master-branch/20868