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

Skip to content

Commit e1200cc

Browse files
anntzeranntzer
committed
numpydocify (some of) mpl_toolkits.
1 parent 0dac001 commit e1200cc

3 files changed

Lines changed: 203 additions & 202 deletions

File tree

‎lib/mpl_toolkits/axes_grid1/axes_grid.py‎

Lines changed: 42 additions & 56 deletions
Original file line numberDiff line numberDiff line change
@@ -140,30 +140,24 @@ def __init__(self, fig,
140140
axes_class=None,
141141
):
142142
"""
143-
Build an :class:`Grid` instance with a grid nrows*ncols
144-
:class:`~matplotlib.axes.Axes` in
145-
:class:`~matplotlib.figure.Figure` *fig* with
146-
*rect=[left, bottom, width, height]* (in
147-
:class:`~matplotlib.figure.Figure` coordinates) or
148-
the subplot position code (e.g., "121").
149-
150-
Optional keyword arguments:
151-
152-
================ ======== =========================================
153-
Keyword Default Description
154-
================ ======== =========================================
155-
direction "row" [ "row" | "column" ]
156-
axes_pad 0.02 float| pad between axes given in inches
157-
or tuple-like of floats,
158-
(horizontal padding, vertical padding)
159-
add_all True bool
160-
share_all False bool
161-
share_x True bool
162-
share_y True bool
163-
label_mode "L" [ "L" | "1" | "all" ]
164-
axes_class None a type object which must be a subclass
165-
of :class:`~matplotlib.axes.Axes`
166-
================ ======== =========================================
143+
Parameters
144+
----------
145+
fig : Figure
146+
The parent figure.
147+
rect : (float, float, float, float) or int
148+
The axes position, as a ``(left, bottom, width, height)`` tuple or
149+
as a three-digit subplot position code (e.g., "121").
150+
direction : {"row", "column"}, defaults to "row"
151+
axes_pad : float or (float, float), defaults to 0.02
152+
Padding or (horizontal padding, vertical padding) between axes, in
153+
inches.
154+
add_all : bool, defaults to True
155+
share_all : bool, defaults to False
156+
share_x : bool, defaults to True
157+
share_y : bool, defaults to True
158+
label_mode : {"L", "1", "all"}, defaults to "L"
159+
axes_class : a type that is a subclass of `matplotlib.axes.Axes`, \
160+
defaults to None
167161
"""
168162
self._nrows, self._ncols = nrows_ncols
169163

@@ -437,38 +431,30 @@ def __init__(self, fig,
437431
axes_class=None,
438432
):
439433
"""
440-
Build an :class:`ImageGrid` instance with a grid nrows*ncols
441-
:class:`~matplotlib.axes.Axes` in
442-
:class:`~matplotlib.figure.Figure` *fig* with
443-
*rect=[left, bottom, width, height]* (in
444-
:class:`~matplotlib.figure.Figure` coordinates) or
445-
the subplot position code (e.g., "121").
446-
447-
Optional keyword arguments:
448-
449-
================ ======== =========================================
450-
Keyword Default Description
451-
================ ======== =========================================
452-
direction "row" [ "row" | "column" ]
453-
axes_pad 0.02 float| pad between axes given in inches
454-
or tuple-like of floats,
455-
(horizontal padding, vertical padding)
456-
add_all True bool
457-
share_all False bool
458-
aspect True bool
459-
label_mode "L" [ "L" | "1" | "all" ]
460-
cbar_mode None [ "each" | "single" | "edge" ]
461-
cbar_location "right" [ "left" | "right" | "bottom" | "top" ]
462-
cbar_pad None
463-
cbar_size "5%"
464-
cbar_set_cax True bool
465-
axes_class None a type object which must be a subclass
466-
of axes_grid's subclass of
467-
:class:`~matplotlib.axes.Axes`
468-
================ ======== =========================================
469-
470-
*cbar_set_cax* : if True, each axes in the grid has a cax
471-
attribute that is bind to associated cbar_axes.
434+
Parameters
435+
----------
436+
fig : Figure
437+
The parent figure.
438+
rect : (float, float, float, float) or int
439+
The axes position, as a ``(left, bottom, width, height)`` tuple or
440+
as a three-digit subplot position code (e.g., "121").
441+
direction : {"row", "column"}, defaults to "row"
442+
axes_pad : float or (float, float), defaults to 0.02
443+
Padding or (horizontal padding, vertical padding) between axes, in
444+
inches.
445+
add_all : bool, defaults to True
446+
share_all : bool, defaults to False
447+
aspect : bool, defaults to True
448+
label_mode : {"L", "1", "all"}, defaults to "L"
449+
cbar_mode : {"each", "single", "edge", None }, defaults to None
450+
cbar_location : {"left", "right", "bottom", "top"}, defaults to "right"
451+
cbar_pad : float, defaults to None
452+
cbar_size : size specification (see `.Size.from_any`), defaults to "5%"
453+
cbar_set_cax : bool, defaults to True
454+
If True, each axes in the grid has a *cax* attribute that is bound
455+
to associated *cbar_axes*.
456+
axes_class : a type that is a subclass of `matplotlib.axes.Axes`, \
457+
defaults to None
472458
"""
473459
self._nrows, self._ncols = nrows_ncols
474460

‎lib/mpl_toolkits/axes_grid1/axes_size.py‎

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,14 @@
1-
21
"""
3-
provides a classes of simple units that will be used with AxesDivider
2+
Provides a classes of simple units that will be used with AxesDivider
43
class (or others) to determine the size of each axes. The unit
54
classes define `get_size` method that returns a tuple of two floats,
65
meaning relative and absolute sizes, respectively.
76
87
Note that this class is nothing more than a simple tuple of two
98
floats. Take a look at the Divider class to see how these two
109
values are used.
11-
1210
"""
11+
1312
from numbers import Number
1413

1514
from matplotlib.axes import Axes

0 commit comments

Comments
 (0)