Skip to content

[Doc]: axvline.x sets x not y #29606

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.

Sign up for GitHub

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

Jump to bottom
Closed
gdmcbain opened this issue Feb 11, 2025 · 0 comments · Fixed by #29607
Closed

[Doc]: axvline.x sets x not y #29606

gdmcbain opened this issue Feb 11, 2025 · 0 comments · Fixed by #29607
Labels
Documentation
Milestone
v3.10-doc

Comments

@gdmcbain
Copy link
Contributor

Documentation Link

https://matplotlib.org/devdocs/api/_as_gen/matplotlib.axes.Axes.axvline.html#matplotlib.axes.Axes.axvline

Problem

The documentation for the first argument, x of axhline describes it as

matplotlib/lib/matplotlib/axes/_axes.py

Lines 820 to 821 in b8b6899

x : float, default: 0
y position in :ref:`data coordinates <coordinate-systems>`.

but really it sets x rather than y.

Suggested improvement

        x : float, default: 0
            x position in :ref:`data coordinates <coordinate-systems>`.
gdmcbain added a commit to gdmcbain/matplotlib that referenced this issue Feb 11, 2025
@gdmcbain
x sets x not y; fixes matplotlib#29606
1797089
@gdmcbain gdmcbain mentioned this issue Feb 12, 2025
Merged
2 tasks
@QuLogic QuLogic added this to the v3.10.0-doc milestone Feb 12, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
Documentation
Projects
None yet
Milestone
v3.10-doc
Development

Successfully merging a pull request may close this issue.

Correct doc for axvline arg x which sets x not y gdmcbain/matplotlib
2 participants
@QuLogic @gdmcbain