8000 Backport PR #14611: Update some axis docstrings. · matplotlib/matplotlib@4c5ed59 · GitHub
[go: up one dir, main page]

Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly

Appearance settings

Commit 4c5ed59

Browse files
dstansbyMeeseeksDev[bot]
authored andcommitted
Backport PR #14611: Update some axis docstrings.
1 parent cdf9e30 commit 4c5ed59

File tree

1 file changed

+7
-9
lines changed

1 file changed

+7
-9
lines changed

lib/matplotlib/axis.py

Lines changed: 7 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1775,28 +1775,28 @@ def _get_tick_boxes_siblings(self, xdir, renderer):
17751775
def _update_label_position(self, renderer):
17761776
"""
17771777
Update the label position based on the bounding box enclosing
1778-
all the ticklabels and axis spine
1778+
all the ticklabels and axis spine.
17791779
"""
17801780
raise NotImplementedError('Derived must override')
17811781

17821782
def _update_offset_text_position(self, bboxes, bboxes2):
17831783
"""
1784-
Update the label position based on the sequence of bounding
1785-
boxes of all the ticklabels
1784+
Update the offset text position based on the sequence of bounding
1785+
boxes of all the ticklabels.
17861786
"""
17871787
raise NotImplementedError('Derived must override')
17881788

17891789
def pan(self, numsteps):
1790-
'Pan *numsteps* (can be positive or negative)'
1790+
"""Pan by *numsteps* (can be positive or negative)."""
17911791
self.major.locator.pan(numsteps)
17921792

17931793
def zoom(self, direction):
1794-
"Zoom in/out on axis; if *direction* is >0 zoom in, else zoom out"
1794+
"""Zoom in/out on axis; if *direction* is >0 zoom in, else zoom out."""
17951795
self.major.locator.zoom(direction)
17961796

17971797
def axis_date(self, tz=None):
17981798
"""
1799-
Sets up x-axis ticks and labels that treat the x data as dates.
1799+
Sets up axis ticks and labels treating data along this axis as dates.
18001800
18011801
Parameters
18021802
----------
@@ -1812,9 +1812,7 @@ def axis_date(self, tz=None):
18121812
self.update_units(datetime.datetime(2009, 1, 1, 0, 0, 0, 0, tz))
18131813

18141814
def get_tick_space(self):
1815-
"""
1816-
Return the estimated number of ticks that can fit on the axis.
1817-
"""
1815+
"""Return the estimated number of ticks that can fit on the axis."""
18181816
# Must be overridden in the subclass
18191817
raise NotImplementedError()
18201818

0 commit comments

Comments
 (0)
0