Skip to content

Correct docstring for axvspan() #11400

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
Jun 8, 2018

Conversation

gsmecher
Copy link
Contributor

@gsmecher gsmecher commented Jun 8, 2018

PR Summary

The Axes.axvspan() function has (always?) had a slightly incorrect DocString, claiming that the Y location is set in data coordinates when it's the X location that matters here. (The Axes.axhspan function makes the same claim, but it's correct there.)

This PR fixes the docstrings. There are no functional changes.

PR Checklist

  • Has Pytest style unit tests
  • Code is PEP 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

@phobson
Copy link
Member

phobson commented Jun 8, 2018

Thanks for the help @gsmecher !

@phobson phobson merged commit b841556 into matplotlib:master Jun 8, 2018
@gsmecher gsmecher deleted the gsmecher/fix-axvspan-docstring branch July 5, 2018 22:39
@QuLogic QuLogic added this to the v3.0.0 milestone Nov 27, 2018
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants