Correct doc for axvline arg x which sets x not y#29607
Merged
QuLogic merged 1 commit intomatplotlib:mainfrom Feb 12, 2025
Merged
Correct doc for axvline arg x which sets x not y#29607QuLogic merged 1 commit intomatplotlib:mainfrom
QuLogic merged 1 commit intomatplotlib:mainfrom
Conversation
There was a problem hiding this comment.
Thank you for opening your first PR into Matplotlib!
If you have not heard from us in a week or so, please leave a new comment below and that should bring it to our attention. Most of our reviewers are volunteers and sometimes things fall through the cracks.
You can also join us on gitter for real-time discussion.
For details on testing, writing docs, and our review process, please see the developer guide
We strive to be a welcoming and open project. Please follow our Code of Conduct.
QuLogic
approved these changes
Feb 12, 2025
Member
|
Thanks @gdmcbain! Congratulations on your first PR to Matplotlib 🎉 We hope to hear from you again. @meeseeksdev backport to v3.10.x |
meeseeksmachine
pushed a commit
to meeseeksmachine/matplotlib
that referenced
this pull request
Feb 12, 2025
meeseeksmachine
pushed a commit
to meeseeksmachine/matplotlib
that referenced
this pull request
Feb 12, 2025
QuLogic
added a commit
that referenced
this pull request
Feb 12, 2025
…607-on-v3.10.x Backport PR #29607 on branch v3.10.x (Correct doc for axvline arg x which sets x not y)
timhoffm
added a commit
that referenced
this pull request
Feb 12, 2025
…607-on-v3.10.0-doc Backport PR #29607 on branch v3.10.0-doc (Correct doc for axvline arg x which sets x not y)
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
As reported in the issue which this closes #29606 , the docstring for the argument x of
axvlinesays that it sets y, but really it sets x. Perhaps this was a copy'n'paste error fromaxhline? Where the first argument is y which does set y.This commit simply emends the doc from y to x to reflect the behaviour.
PR checklist