Skip to content

Rework pylab docstring. #16437

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
Feb 7, 2020
Merged

Rework pylab docstring. #16437

merged 1 commit into from
Feb 7, 2020

Conversation

anntzer
Copy link
Contributor

@anntzer anntzer commented Feb 7, 2020

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.

PR Summary

PR Checklist

  • Has Pytest style unit tests
  • Code is Flake 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

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.
@tacaswell tacaswell added this to the v3.3.0 milestone Feb 7, 2020
@timhoffm timhoffm merged commit 81e4720 into matplotlib:master Feb 7, 2020
@anntzer anntzer deleted the unpylabdoc branch February 8, 2020 10:32
@tacaswell
Copy link
Member

Please see https://discourse.matplotlib.org/t/removed-commits-from-master-branch/20868. This merge was shadow-reverted and well need to be re-made.

@anntzer anntzer mentioned this pull request Feb 8, 2020
6 tasks
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.

3 participants