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

Skip to content

Commit 29d1b1c

Browse files
committed
Cleanup docstring of subplots().
1 parent d2a12cb commit 29d1b1c

File tree

1 file changed

+11
-15
lines changed

1 file changed

+11
-15
lines changed

lib/matplotlib/gridspec.py

Lines changed: 11 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -249,12 +249,10 @@ def subplots(self, sharex=False, sharey=False, squeeze=True,
249249
Controls sharing of properties among x (*sharex*) or y (*sharey*)
250250
axes:
251251
252-
- True or 'all': x- or y-axis will be shared among all
253-
subplots.
254-
- False or 'none': each subplot x- or y-axis will be
255-
independent.
256-
- 'row': each subplot row will share an x- or y-axis.
257-
- 'col': each subplot column will share an x- or y-axis.
252+
- True or 'all': x- or y-axis will be shared among all subplots.
253+
- False or 'none': each subplot x- or y-axis will be independent.
254+
- 'row': each subplot row will share an x- or y-axis.
255+
- 'col': each subplot column will share an x- or y-axis.
258256
259257
When subplots have a shared x-axis along a column, only the x tick
260258
labels of the bottom subplot are created. Similarly, when subplots
@@ -266,21 +264,19 @@ def subplots(self, sharex=False, sharey=False, squeeze=True,
266264
- If True, extra dimensions are squeezed out from the returned
267265
array of Axes:
268266
269-
- if only one subplot is constructed (nrows=ncols=1), the
270-
resulting single Axes object is returned as a scalar.
271-
- for Nx1 or 1xM subplots, the returned object is a 1D numpy
272-
object array of Axes objects.
273-
- for NxM, subplots with N>1 and M>1 are returned
274-
as a 2D array.
267+
- if only one subplot is constructed (nrows=ncols=1), the
268+
resulting single Axes object is returned as a scalar.
269+
- for Nx1 or 1xM subplots, the returned object is a 1D numpy
270+
object array of Axes objects.
271+
- for NxM, subplots with N>1 and M>1 are returned as a 2D array.
275272
276273
- If False, no squeezing at all is done: the returned Axes object
277274
is always a 2D array containing Axes instances, even if it ends
278275
up being 1x1.
279276
280277
subplot_kw : dict, optional
281-
Dict with keywords passed to the
282-
:meth:`~matplotlib.figure.Figure.add_subplot` call used to create
283-
each subplot.
278+
Dict with keywords passed to the `~.Figure.add_subplot` call used
279+
to create each subplot.
284280
285281
Returns
286282
-------

0 commit comments

Comments
 (0)