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

Update some axis docstrings. #14611

Merged
merged 1 commit into from Jun 25, 2019
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
16 changes: 7 additions & 9 deletions lib/matplotlib/axis.py
Expand Up @@ -1790,28 +1790,28 @@ def _get_tick_boxes_siblings(self, xdir, renderer):
def _update_label_position(self, renderer):
"""
Update the label position based on the bounding box enclosing
all the ticklabels and axis spine
all the ticklabels and axis spine.
"""
raise NotImplementedError('Derived must override')

def _update_offset_text_position(self, bboxes, bboxes2):
"""
Update the label position based on the sequence of bounding
boxes of all the ticklabels
Update the offset text position based on the sequence of bounding
boxes of all the ticklabels.
"""
raise NotImplementedError('Derived must override')

def pan(self, numsteps):
'Pan *numsteps* (can be positive or negative)'
"""Pan by *numsteps* (can be positive or negative)."""
self.major.locator.pan(numsteps)

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

def axis_date(self, tz=None):
"""
Sets up x-axis ticks and labels that treat the x data as dates.
Sets up axis ticks and labels treating data along this axis as dates.

Parameters
----------
Expand All @@ -1827,9 +1827,7 @@ def axis_date(self, tz=None):
self.update_units(datetime.datetime(2009, 1, 1, 0, 0, 0, 0, tz))

def get_tick_space(self):
"""
Return the estimated number of ticks that can fit on the axis.
"""
"""Return the estimated number of ticks that can fit on the axis."""
# Must be overridden in the subclass
raise NotImplementedError()

Expand Down