Skip to content

Return minorticks as array, not as list. #21544

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 1 commit into from
Nov 7, 2021

Conversation

anntzer
Copy link
Contributor

@anntzer anntzer commented Nov 5, 2021

The return type changed accidentally when remove_overlapping_locs was
introduced (except for NullLocator, which always returned a plain list).
Make the API consistent with majorticks, which are (mostly) always
returned as an array.

Modifying the test in test_colorbar is so-so, but that's the only place,
AFAICT, that currently tests anything with get_ticklocs(minor=True),
so...

Closes #19559.

PR Summary

PR Checklist

  • Has pytest style unit tests (and pytest passes).
  • Is Flake 8 compliant (run flake8 on changed files to check).
  • New features are documented, with examples if plot related.
  • Documentation is sphinx and numpydoc compliant (the docs should build without error).
  • Conforms to Matplotlib style conventions (install flake8-docstrings and run flake8 --docstring-convention=all).
  • New features have an entry in doc/users/next_whats_new/ (follow instructions in README.rst there).
  • API changes documented in doc/api/next_api_changes/ (follow instructions in README.rst there).

The return type changed accidentally when remove_overlapping_locs was
introduced (except for NullLocator, which always returned a plain list).
Make the API consistent with majorticks, which are (mostly) always
returned as an array.

Modifying the test in test_colorbar is so-so, but that's the only place,
AFAICT, that currently tests anything with get_ticklocs(minor=True),
so...
@timhoffm
Copy link
Member

timhoffm commented Nov 7, 2021

Should this be 3.5?

@anntzer
Copy link
Contributor Author

anntzer commented Nov 7, 2021

Technically that's a regression in 3.1, but again either way is fine for me.

@timhoffm timhoffm added this to the v3.6.0 milestone Nov 7, 2021
@timhoffm
Copy link
Member

timhoffm commented Nov 7, 2021

This can either be considered a bug fix or an API change. I've decided not to push this into 3.5 on the last minute. This has been around for some time. One release more does not hurt a lot.

@timhoffm timhoffm merged commit b525983 into matplotlib:main Nov 7, 2021
@anntzer anntzer deleted the minortickarray branch November 7, 2021 23:18
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.

Axes.get_xticks() returns a numpy array but Axes.get_xticks(minor=True) returns a plain list
3 participants