Skip to content
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

Make Poly3DCollection.set_zsort less lenient. #12049

Merged
merged 1 commit into from Sep 7, 2018

Conversation

anntzer
Copy link
Contributor

@anntzer anntzer commented Sep 6, 2018

set_zsort(False) has never worked (it ultimately raises
ValueError('whoops') in draw() since mplot3d was first merged in
edd492e), so just don't pretend to support it.

Once support for False is removed, it makes sense to also deprecate
support for True, which was a synonym for 'average', and just accept the
three strings 'average', 'min', and 'max'. And let's not silently drop
invalid strings...

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

if zsort is True:
cbook.warn_deprecated(
"3.1", "Passing True to mean 'average' for set_zsort is "
"deprecated; pass 'average' instead.")
Copy link
Member

Choose a reason for hiding this comment

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

We should decide when we will remove this. I don't really have a feel for how prevalent this is

Copy link
Contributor Author

Choose a reason for hiding this comment

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

3.3 would be normal.

set_zsort(False) has never worked (it ultimately raises
ValueError('whoops') in `draw()` since mplot3d was first merged in
edd492e), so just don't pretend to support it.

Once support for False is removed, it makes sense to also deprecate
support for True, which was a synonym for 'average', and just accept the
three strings 'average', 'min', and 'max'.  And let's not silently drop
invalid strings...
Copy link
Member

@NelleV NelleV left a comment

Choose a reason for hiding this comment

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

LGTM 👍

@WeatherGod WeatherGod merged commit 31c55ea into matplotlib:master Sep 7, 2018
@anntzer anntzer deleted the set_zsort branch September 7, 2018 19:28
@tacaswell tacaswell added this to the v3.1 milestone Sep 7, 2018
@jklymak jklymak mentioned this pull request Sep 14, 2018
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.

None yet

4 participants