Skip to content

Correct docstring of RangeSlider.on_changed #24801

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
Dec 21, 2022

Conversation

ksunden
Copy link
Member

@ksunden ksunden commented Dec 21, 2022

PR Summary

Small correction to a docstring to match implementation.

The call is actually made with a tuple (vmin, vmax).

Somebody expecting a numpy array may be surprised to find it is not
actually an array.

PR Checklist

Documentation and Tests

  • [n/a] Has pytest style unit tests (and pytest passes)
  • [n/a] Documentation is sphinx and numpydoc compliant (the docs should build without error).
  • [n/a] New plotting related features are documented with examples.

Release Notes

  • [n/a] New features are marked with a .. versionadded:: directive in the docstring and documented in doc/users/next_whats_new/
  • [n/a] API changes are marked with a .. versionchanged:: directive in the docstring and documented in doc/api/next_api_changes/
  • [n/a] Release notes conform with instructions in next_whats_new/README.rst or next_api_changes/README.rst

The call is actually made with a tuple (vmin, vmax).

Somebody expecting a numpy array may be surprised to find it is not
actually an array.
@story645 story645 added this to the v3.7.0 milestone Dec 21, 2022
@timhoffm timhoffm merged commit f00862d into matplotlib:main Dec 21, 2022
@ksunden ksunden deleted the range_slider_callback branch December 27, 2022 18:50
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.

4 participants