Skip to content

DOC: clarify that savefig(..., transparent=False) has no effect#20221

Merged
jklymak merged 2 commits intomatplotlib:masterfrom
tacaswell:doc_savefig_transparent
May 14, 2021
Merged

DOC: clarify that savefig(..., transparent=False) has no effect#20221
jklymak merged 2 commits intomatplotlib:masterfrom
tacaswell:doc_savefig_transparent

Conversation

@tacaswell
Copy link
Copy Markdown
Member

@tacaswell tacaswell commented May 13, 2021

PR Summary

re-closes #14339

PR Checklist

  • Documentation is sphinx and numpydoc compliant (the docs should build without error).

@tacaswell tacaswell added this to the v3.4.3 milestone May 13, 2021
jklymak
jklymak reviewed May 13, 2021
View reviewed changes
Comment thread lib/matplotlib/figure.py Outdated
and/or edgecolor are specified via kwargs.

If *False* has no effect and leaves the color of the Axes and
Figure patches as they are.
Copy link
Copy Markdown
Member

@jklymak jklymak May 13, 2021

Choose a reason for hiding this comment

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

Can we clarify "...as they are"? Maybe "as set by facecolor kwarg."?

Copy link
Copy Markdown
Member Author

@tacaswell tacaswell May 14, 2021

Choose a reason for hiding this comment

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

Added a note about that and ended up re-ordering the signature and the docstring to put what is in my judgement is more useful higher up.

@jklymak jklymak merged commit c5d7ce2 into matplotlib:master May 14, 2021
@lumberbot-app
Copy link
Copy Markdown

lumberbot-app Bot commented May 14, 2021

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.4.x
$ git pull
  1. Cherry pick the first parent branch of the this PR on top of the older branch:
$ git cherry-pick -m1 c5d7ce25a9f2e3d4a2f6a43233babcba89e57aac
  1. You will likely have some merge/cherry-pick conflict here, fix them and commit:
$ git commit -am 'Backport PR #20221: DOC: clarify that savefig(..., transparent=False) has no effect'
  1. Push to a named branch :
git push YOURFORK v3.4.x:auto-backport-of-pr-20221-on-v3.4.x
  1. Create a PR against branch v3.4.x, I would have named this PR:

"Backport PR #20221 on branch v3.4.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.

@tacaswell tacaswell deleted the doc_savefig_transparent branch May 14, 2021 14:35
@tacaswell tacaswell modified the milestones: v3.4.3, v3.5.0 May 14, 2021
@tacaswell
Copy link
Copy Markdown
Member Author

tacaswell commented May 14, 2021

Because documentation merge conflicts are much harder to resolve than code conflicts and this is clarifying, not correcting, a docstring, I'm going to re-milestone this for 3.5.

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

Reviewers

@jklymak jklymak jklymak approved these changes

Assignees

No one assigned

Labels

Documentation

Projects

None yet

Milestone

v3.5.0

Development

Successfully merging this pull request may close these issues.

Transparency always on for PNG in version 3.1.0

3 participants

@tacaswell @jklymak @QuLogic