8000 Backport PR #16080 on branch v3.2.x (Cleanup docstrings in backend_bases.py) by timhoffm · Pull Request #16094 · matplotlib/matplotlib · GitHub
[go: up one dir, main page]
Skip to content

Backport PR #16080 on branch v3.2.x (Cleanup docstrings in backend_bases.py) #16094

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 1 commit into from
Jan 4, 2020
Merged

Backport PR #16080 on branch v3.2.x (Cleanup docstrings in backend_bases.py) #16094

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
97 changes: 46 additions & 51 deletions lib/matplotlib/backend_bases.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -104,8 +104,8 @@ def register_backend(format, backend, description=None):
backend : module string or canvas class
Backend for handling file output

description : str, optional
Description of the file type. Defaults to an empty string
description : str, default: ""
Description of the file type.
"""
if description is None:
description = ''
Expand Down Expand Up @@ -461,14 +461,14 @@ def draw_image(self, gc, x, y, im, transform=None):
Parameters
----------
gc : `GraphicsContextBase`
a graphics context with clipping information.
A graphics context with clipping information.

x : scalar
the distance in physical units (i.e., dots or pixels) from the left
The distance in physical units (i.e., dots or pixels) from the left
hand side of the canvas.

y : scalar
the distance in physical units (i.e., dots or pixels) from the
The distance in physical units (i.e., dots or pixels) from the
bottom side of the canvas.

im : array-like, shape=(N, M, 4), dtype=np.uint8
Expand Down Expand Up @@ -517,22 +517,22 @@ def draw_text(self, gc, x, y, s, prop, angle, ismath=False, mtext=None):
----------
gc : `GraphicsContextBase`
The graphics context.
x : scalar
x : float
The x location of the text in display coords.
y : scalar
y : float
The y location of the text baseline in display coords.
s : str
The text string.
prop : `matplotlib.font_manager.FontProperties`
The font properties.
angle : scalar
The rotation angle in degrees.
angle : float
The rotation angle in degrees anti-clockwise.
mtext : `matplotlib.text.Text`
The original text object to be rendered.

Notes
-----
**backend implementers note**
**Note for backend implementers:**

When you are trying to determine if you have gotten your bounding box
right (which is what enables the text layout/alignment to work
Expand Down Expand Up @@ -664,11 +664,11 @@ def points_to_pixels(self, points):
doesn't have a dpi, e.g., postscript or svg). Some imaging
systems assume some value for pixels per inch::

points to pixels = points * pixels_per_inch/72.0 * dpi/72.0
points to pixels = points * pixels_per_inch/72 * dpi/72

Parameters
----------
points : scalar or array-like
points : float or array-like
a float or a numpy array of float

Returns
Expand Down Expand Up @@ -1022,11 +1022,10 @@ def set_sketch_params(self, scale=None, length=None, randomness=None):
The amplitude of the wiggle perpendicular to the source line, in
pixels. If scale is `None`, or not provided, no sketch filter will
be provided.
length : float, optional
The length of the wiggle along the line, in pixels (default 128).
randomness : float, optional
The scale factor by which the length is shrunken or expanded
(default 16).
length : float, default: 128
The length of the wiggle along the line, in pixels.
randomness : float, default: 16
The scale factor by which the length is shrunken or expanded.
"""
self._sketch = (
None if scale is None
Expand Down Expand Up @@ -1259,12 +1258,10 @@ class ResizeEvent(Event):

Attributes
----------
width : scalar
width of the canvas in pixels

height : scalar
height of the canvas in pixels

width : int
Width of the canvas in pixels.
height : int
Height of the canvas in pixels.
"""
def __init__(self, name, canvas):
Event.__init__(self, name, canvas)
Expand All @@ -1287,20 +1284,16 @@ class LocationEvent(Event):

Attributes
----------
x : scalar
x position - pixels from left of canvas

y : scalar
y position - pixels from bottom of canvas

inaxes : bool
the :class:`~matplotlib.axes.Axes` instance if mouse is over axes

xdata : scalar
x coord of mouse in data coords

ydata : scalar
y coord of mouse in data coords
x : int
x position - pixels from left of canvas.
y : int
y position - pixels from bottom of canvas.
inaxes : `~.axes.Axes` or None
The `~.axes.Axes` instance over which the mouse is, if any.
xdata : float or None
x data coordinate of the mouse.
ydata : float or None
y data coordinate of the mouse.
"""

lastevent = None # the last event that was triggered before this one
Expand Down Expand Up @@ -1402,7 +1395,7 @@ class MouseEvent(LocationEvent):
The key pressed when the mouse event triggered, e.g. 'shift'.
See `KeyEvent`.

step : scalar
step : int
The number of scroll steps (positive for 'up', negative for 'down').
This applies only to 'scroll_event' and defaults to 0 otherwise.

Expand Down Expand Up @@ -1989,29 +1982,31 @@ def print_figure(self, filename, dpi=None, facecolor=None, edgecolor=None,
filename
can also be a file object on image backends

orientation : {'landscape', 'portrait'}, optional
orientation : {'landscape', 'portrait'}, default: 'portrait'
only currently applies to PostScript printing.

dpi : scalar, optional
the dots per inch to save the figure in; if None, use savefig.dpi

facecolor : color or None, optional
the facecolor of the figure; if None, defaults to savefig.facecolor
facecolor : color, default: :rc:`savefig.facecolor`
The facecolor of the figure.

edgecolor : color or None, optional
the edgecolor of the figure; if None, defaults to savefig.edgecolor
edgecolor : color, default: :rc:`savefig.edgecolor`
The edgecolor of the figure.

format : str, optional
when set, forcibly set the file format to save to
Force a specific file format. If not given, the format is inferred
from the *filename* extension, and if that fails from
:rc:`savefig.format`.

bbox_inches : str or `~matplotlib.transforms.Bbox`, optional
bbox_inches : 'tight' or `~matplotlib.transforms.Bbox`, \
default: :rc:`savefig.bbox`
Bbox in inches. Only the given portion of the figure is
saved. If 'tight', try to figure out the tight bbox of
the figure. If None, use savefig.bbox
the figure.

pad_inches : scalar, optional
Amount of padding around the figure when bbox_inches is
'tight'. If None, use savefig.pad_inches
pad_inches : float, default: :rc:`savefig.pad_inches`
Amount of padding around the figure when *bbox_inches* is 'tight'.

bbox_extra_artists : list of `~matplotlib.artist.Artist`, optional
A list of extra artists that will be considered when the
Expand Down Expand Up @@ -3400,9 +3395,9 @@ def mainloop(self):

class ShowBase(_Backend):
"""
Simple base class to generate a show() callable in backends.
Simple base class to generate a ``show()`` function in backends.

Subclass must override mainloop() method.
Subclass must override ``mainloop()`` method.
"""

def __call__(self, block=None):
Expand Down
0