Skip to content
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

Typos in doc of vlines #2943

Closed
cloudhan opened this issue Mar 30, 2014 · 4 comments
Closed

Typos in doc of vlines #2943

cloudhan opened this issue Mar 30, 2014 · 4 comments
Milestone

Comments

@cloudhan
Copy link

Help on function vlines in module matplotlib.pyplot:

vlines(x, ymin, ymax, colors='k', linestyles='solid', label='', hold=None, **kwargs)
Plot vertical lines.

Plot vertical lines at each x from ymin to ymax.

Parameters

x : scalar or 1D array_like
x-indexes where to plot the lines.

xmin, xmax : scalar or 1D array_like
Respective beginning and end of each line. If scalars are
provided, all lines will have same length.

@cloudhan
Copy link
Author

the xmin and xmax should be ymin and ymax

@tacaswell
Copy link
Member

@heliumhgy Could you put together a pull request to fix the typos?

@tacaswell tacaswell added this to the v1.4.0 milestone Mar 31, 2014
@cloudhan
Copy link
Author

cloudhan commented Apr 1, 2014

@tacaswell
Sorry, seems this typo has been fixed in master branch and 1.3.x branch.
I get this from /usr/lib/python2.7/site-packages/matplotlib/axis.py

    def vlines(self, x, ymin, ymax, colors='k', linestyles='solid',
                     label='', **kwargs):
        """
        Plot vertical lines.

        Plot vertical lines at each `x` from `ymin` to `ymax`.

        Parameters
        ----------
        x : scalar or 1D array_like
            x-indexes where to plot the lines.

        xmin, xmax : scalar or 1D array_like
            Respective beginning and end of each line. If scalars are
            provided, all lines will have same length.

        colors : array_like of colors, optional, default: 'k'

while in repo, the line:

        xmin, xmax : scalar or 1D array_like

has been replace by

        ymin, ymax : scalar or 1D array_like

https://github.com/matplotlib/matplotlib/blob/v1.3.x/lib/matplotlib/axes.py line 3756
or
https://github.com/matplotlib/matplotlib/blob/master/lib/matplotlib/axes/_axes.py line 1005

@tacaswell
Copy link
Member

Closing this as already fixed.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

3 participants