Thanks to visit codestin.com
Credit goes to github.com

Skip to content

DOC Convert axes docstrings to numpydoc: #7205 #7389

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

Merged
merged 4 commits into from
Nov 7, 2016
Merged

DOC Convert axes docstrings to numpydoc: #7205 #7389

Changes from 1 commit
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
a2b990d
Convert docstring for set_xlim(), per issue #7205
cfackler Nov 1, 2016
49a8d83
Convert set_xlim and set_ylim docstrings; #7205
cfackler Nov 1, 2016
349909e
Convert get_xlim and get_ylim docstrings
cfackler Nov 3, 2016
803a05f
DOC Remove old API notes from updated docstrings
cfackler Nov 6, 2016
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
Next Next commit
Convert docstring for set_xlim(), per issue #7205 
Convert set_xlim() docstring to numpydoc format.
  • Loading branch information
@cfackler
cfackler committed Nov 3, 2016
commit a2b990dda73b314ab62f2e573b62fe79f45b88e9
65 changes: 40 additions & 25 deletions lib/matplotlib/axes/_base.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2789,43 +2789,58 @@ def get_xlim(self):

def set_xlim(self, left=None, right=None, emit=True, auto=False, **kw):
"""
Set the data limits for the xaxis
Set the data limits for the x-axis

Examples::
Parameters
----------
left : scalar, optional
The left xlim (default: None, which leaves the left limit
unchanged). The previous name `xmin` may be used instead.

set_xlim((left, right))
set_xlim(left, right)
set_xlim(left=1) # right unchanged
set_xlim(right=1) # left unchanged
right : scalar, optional
The right xlim (default: None, which leaves the right limit
unchanged). The previous name `xmax` may be used instead.

Keyword arguments:
emit : bool, optional
Whether to notify observers of limit change (default: True).

*left*: scalar
The left xlim; *xmin*, the previous name, may still be used
auto : {True, False, None}, optional
Whether to turn on autoscaling of the x-axis. True turns on,
False turns off (default action), None leaves unchanged.

*right*: scalar
The right xlim; *xmax*, the previous name, may still be used
xlimits : tuple, optional
The left and right xlims may be passed as the tuple
(`left`, `right`) as the first positional argument (or as
the `left` keyword argument).

*emit*: [ *True* | *False* ]
Notify observers of limit change
Returns
-------
xlimits : tuple
Returns the current x-axis limits, reflecting any changes
Copy link
Member

Choose a reason for hiding this comment

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

I'd say "returns the new x-axis limits"

made by this call, as (`left`, `right`).

*auto*: [ *True* | *False* | *None* ]
Turn *x* autoscaling on (*True*), off (*False*; default),
or leave unchanged (*None*)
Notes
-----
The `left` value may be greater than the `right` value, in which
case the x-axis values will decrease from left to right.

Note, the *left* (formerly *xmin*) value may be greater than
the *right* (formerly *xmax*).
For example, suppose *x* is years before present.
Then one might use::
Examples
--------
>>> set_xlim(left, right)
>>> set_xlim((left, right))
>>> left, right = set_xlim(left, right)

set_xlim(5000, 0)
One limit may be left unchanged.

so 5000 years ago is on the left of the plot and the
present is on the right.
>>> set_xlim(right=right_lim)

Returns the current xlimits as a length 2 tuple
Limits may be passed in reverse order. For example, suppose `x`
represents the number of years before present. The x-axis limits
might be set like the following so 5000 years ago is on the left
of the plot and the present is on the right.

>>> set_xlim(5000, 0)

ACCEPTS: length 2 sequence of floats
"""
if 'xmin' in kw:
left = kw.pop('xmin')
Expand Down