Skip to content

DOC changed documentation for axvspan to numpydoc format @NelleV #7039

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

Closed
wants to merge 1 commit into from
Closed

DOC changed documentation for axvspan to numpydoc format @NelleV #7039

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
61 changes: 36 additions & 25 deletions lib/matplotlib/axes/_axes.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -856,39 +856,50 @@ def axvspan(self, xmin, xmax, ymin=0, ymax=1, **kwargs):
"""
Add a vertical span (rectangle) across the axes.

Call signature::

axvspan(xmin, xmax, ymin=0, ymax=1, **kwargs)

*x* coords are in data units and *y* coords are in axes (relative
0-1) units.

Draw a vertical span (rectangle) from *xmin* to *xmax*. With
the default values of *ymin* = 0 and *ymax* = 1, this always
Draw a vertical span (rectangle) from `xmin` to `xmax`. With
the default values of `ymin` = 0 and `ymax` = 1. This always
spans the yrange, regardless of the ylim settings, even if you
change them, e.g., with the :meth:`set_ylim` command. That is,
the vertical extent is in axes coords: 0=bottom, 0.5=middle,
1.0=top but the *y* location is in data coordinates.
1.0=top but the y location is in data coordinates.

Return value is the :class:`matplotlib.patches.Polygon`
instance.

Examples:

* draw a vertical green translucent rectangle from x=1.25 to 1.55 that
spans the yrange of the axes::

>>> axvspan(1.25, 1.55, facecolor='g', alpha=0.5)
Parameters
----------
xmin : scalar
Number indicating the first X-axis coordinate of the vertical
span rectangle in data units.
xmax : scalar
Number indicating the second X-axis coordinate of the vertical
span rectangle in data units.
ymin : scalar, optional
Number indicating the first Y-axis coordinate of the vertical
span rectangle in relative Y-axis units (0-1). Default to 0.
ymax : scalar, optional
Number indicating the second Y-axis coordinate of the vertical
span rectangle in relative Y-axis units (0-1). Default to 1.

Returns
-------
rectangle : matplotlib.patches.Polygon
Vertical span (rectangle) from (xmin, ymin) to (xmax, ymax).

Valid kwargs are :class:`~matplotlib.patches.Polygon`
properties:
Other Parameters
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Why remove this?

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Agree with @QuLogic this should probably stay

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think it should be removed and moved to a place with clean and readable summaries. These make the documentation unreadable in an Ipython terminal. They also make the documentation much harder to maintain and modify. They are also not standard, and thus makes contributing to the documentation much harder.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

If these sorts of tables are going to be removed, it should be done in a coordinated way ( @efiring is also on board with this) not piecemeal.

----------------
**kwargs
Optional parameters are properties of the class
matplotlib.patches.Polygon.

%(Polygon)s
See Also
--------
axhspan

Examples
--------
Draw a vertical, green, translucent rectangle from x = 1.25 to
x = 1.55 that spans the yrange of the axes.

.. seealso::
>>> axvspan(1.25, 1.55, facecolor='g', alpha=0.5)

:meth:`axhspan`
for example plot and source code
"""
trans = self.get_xaxis_transform(which='grid')

Expand Down