Skip to content

Update matplotlib.__doc__. #16248

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.

Sign up for GitHub

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

Jump to bottom
Merged
merged 1 commit into from
Jan 20, 2020
Merged

Update matplotlib.__doc__. #16248

merged 1 commit into from
Jan 20, 2020

Conversation

anntzer
Copy link
Contributor

@anntzer anntzer commented Jan 17, 2020

A bit of rewording. The main point is regarding matplotlib.use(), whose
doc was just plain wrong re: backend switching.

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

timhoffm
timhoffm approved these changes Jan 17, 2020
View reviewed changes
Copy link
Member

@timhoffm timhoffm left a comment •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Conditional on CI.

ImportanceOfBeingErnest
ImportanceOfBeingErnest reviewed Jan 17, 2020
View reviewed changes
lib/matplotlib/__init__.py Outdated
a function for setting groups of rcParams values
`~matplotlib.use`
Setting the Matplotlib backend. It is not possible to switch between
multiple GUI backends.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

While it's correct that it doesn't need to be used before importing pyplot (anymore), it would still be helpful for users to know that they should use it before doing anything substantial, like creating a pyplot figure. Also a reference to pyplot.switch_backend might be good here.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Edited to clarify the first point. I would rather not mention switch_backend -- in fact I would rather deprecate it as being essentially duplicate with use().

@anntzer
Update matplotlib.__doc__.
4fd5296 
A bit of rewording.  The main point is regarding matplotlib.use(), whose
doc was just plain wrong re: backend switching.
@tacaswell tacaswell added this to the v3.2.0 milestone Jan 20, 2020
@tacaswell
Copy link
Member

The failures are pytest + qt related.

@tacaswell tacaswell merged commit 20805b8 into matplotlib:master Jan 20, 2020
@lumberbot-app
Copy link

lumberbot-app bot commented Jan 20, 2020

Owee, I'm MrMeeseeks, Look at me.

There seem to be a conflict, please backport manually. Here are approximate instructions:

  1. Checkout backport branch and update it.
$ git checkout v3.2.x
$ git pull
  1. Cherry pick the first parent branch of the this PR on top of the older branch:
$ git cherry-pick -m1 20805b805132307b1e6f9546ae2238234aa4e44e
  1. You will likely have some merge/cherry-pick conflict here, fix them and commit:
$ git commit -am 'Backport PR #16248: Update matplotlib.__doc__.'
  1. Push to a named branch :
git push YOURFORK v3.2.x:auto-backport-of-pr-16248-on-v3.2.x
  1. Create a PR against branch v3.2.x, I would have named this PR:

"Backport PR #16248 on branch v3.2.x"

And apply the correct labels and milestones.

Congratulation you did some good work ! Hopefully your backport PR will be tested by the continuous integration and merged soon!

If these instruction are inaccurate, feel free to suggest an improvement.

@anntzer anntzer deleted the mpldoc branch January 20, 2020 07:50
@timhoffm
Copy link
Member

timhoffm commented Feb 3, 2020

Meanwhile, v3.2.0 has been tagged, and I don't think, it's essential to backport this.

@timhoffm timhoffm modified the milestones: v3.2.0, v3.3.0 Feb 3, 2020
@QuLogic
Copy link
Member

QuLogic commented Feb 13, 2020

3.2.0 has not yet been tagged, but I'm not in any hurry to backport this myself.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@ImportanceOfBeingErnest ImportanceOfBeingErnest ImportanceOfBeingErnest left review comments

@timhoffm timhoffm timhoffm approved these changes

Assignees
No one assigned
Labels
Documentation
Projects
None yet
Milestone
v3.3.0
Development

Successfully merging this pull request may close these issues.
5 participants
@anntzer @tacaswell @timhoffm @QuLogic @ImportanceOfBeingErnest