Skip to content

API: un-deprecate keyword only args to set_xlim, set_ylim #13425

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 2 commits into from
Feb 22, 2019

Conversation

tacaswell
Copy link
Member

These were originally documented and deprecated in #11137 however
in later discussion we learned:

  • the 'left, right' / 'top, bottom' names don't make sense in the
    context of non-rectangular plots
  • we have at least one frustrated user

The original names were xmin, xmax but were changed to left, right
in 9ca5db0 (pre 1.0) and the kwarg
popping was added for back-compatibility.

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
  • Documented in doc/api/api_changes.rst if API changed in a backward-incompatible way

These were originally documented and deprecated in matplotlib#11137 however
in later discussion we learned:

 - the 'left, right' / 'top, bottom' names don't make sense in the
   context of non-rectangular plots
 - we have at least one frustrated user

The original names were `xmin, xmax` but were changed to `left, right`
in 9ca5db0 (pre 1.0) and the kwarg
popping was added for back-compatibility.
@tacaswell tacaswell added the Release critical For bugs that make the library unusable (segfaults, incorrect plots, etc) and major regressions. label Feb 13, 2019
@tacaswell tacaswell added this to the v3.1.0 milestone Feb 13, 2019
@@ -154,8 +154,9 @@ Different exception types for undocumented options
and ``right`` arguments. :meth:`~matplotlib.axes.Axes.set_ylim` and the
3D equivalents (e.g. :meth:`~mpl_toolkits.axes.Axes3D.set_zlim3d`) had a
corresponding problem.
The ``_min`` and ``_max`` arguments are now deprecated, and a ``TypeError``
will be raised if they would override the earlier limit arguments.
A ``TypeError`` will be raised if they would override the earlier
Copy link
Member

Choose a reason for hiding this comment

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

It's reasonable to modify the changes in 3.0 section of the 3.1 docs. Additionally, I would add an entry to the section "changes in 3.1". People typically do not read the changelog of past versions.

@jklymak jklymak merged commit aa360dc into matplotlib:master Feb 22, 2019
@tacaswell tacaswell deleted the dedeprecate_xmin_xmax branch January 20, 2020 00:49
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Release critical For bugs that make the library unusable (segfaults, incorrect plots, etc) and major regressions.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants