NotificationsYou must be signed in to change notification settings
Fork7.9k
Star21.3k

Rework pylab docstring.#16441

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 ourterms of service andprivacy statement. We’ll occasionally send you account related emails.

Already on GitHub?Sign in to your account

Jump to bottom

Closed

anntzer wants to merge1 commit intomatplotlib:masterfromanntzer:unpylabdoc

Closed

Rework pylab docstring.#16441

anntzer wants to merge1 commit intomatplotlib:masterfromanntzer:unpylabdoc

Conversation

Copy link

Contributor

anntzer commentedFeb 8, 2020

Redo of#16437 which was lost due to#8896 (comment).

The old pylab module docstring was not rendered anywhere in the html
docs (it was only visible with pydoc or with IPython'spylab?), 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.

PR Summary

PR Checklist

Has Pytest style unit tests
Code isFlake 8 compliant
New features are documented, with examples if plot related
Documentation is sphinx and numpydoc compliant
Added an entry to doc/users/next_whats_new/ if major new feature (follow instructions in README.rst there)
Documented in doc/api/api_changes.rst if API changed in a backward-incompatible way

Rework pylab docstring.

60bf6eb

The old pylab module docstring was not rendered anywhere in the htmldocs (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 docstringby the warning discouraging the use of pylab, and use that as entry inthe html docs.

anntzer added the Documentation label

Feb 8, 2020

anntzer added this to thev3.3.0 milestone

Feb 8, 2020