GV

GeezerVison

The World Wide Web, restored to 800 pixels of glory.

Home|About|Gaming cabinet|Archives|How it works|Starter sites

On this site

  • Sign in
  • ActionsCI/CD and automation
  • CodespacesCloud development environments
  • All Features
  • Documentation
  • Training
  • Certifications
  • Build with Copilot
  • Customize Copilot
  • Integrations
  • Trending repos
  • GitHub Sponsors
  • Developer articles
  • Enterprises

This view

  • Original page
  • New address

GeezerVison is showing github.com — Rework pylab docstring. by anntzer · Pull Request #16441 · matplotlib/matplotlib

Conversation

@anntzer

@anntzer anntzer commented Feb 8, 2020

Copy link
Copy Markdown
Contributor

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'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

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.
All reactions
@anntzer
Rework pylab docstring.
60bf6eb 
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 anntzer added the Documentation label Feb 8, 2020
@anntzer anntzer added this to the v3.3.0 milestone Feb 8, 2020
@anntzer

anntzer commented Feb 8, 2020

Copy link
Copy Markdown
Contributor Author

Oops, missed #16439.
All reactions

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.
@anntzer anntzer closed this Feb 8, 2020
@anntzer anntzer added the status: duplicate label Feb 8, 2020
@anntzer
anntzer deleted the unpylabdoc branch February 8, 2020 23:46
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

No reviews

Uh oh!

There was an error while loading. Please reload this page.

Assignees

No one assigned

Labels

Documentation status: duplicate

Projects

None yet

Milestone

v3.3.0

Development

Successfully merging this pull request may close these issues.

Uh oh!

There was an error while loading. Please reload this page.

1 participant

@anntzer
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.
You are visitor 01402520 — GeezerVison does not store the pages you look up.
Best viewed with Netscape Navigator 4.7 or Internet Explorer 6 at 800×600. No cookies required.