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

Skip to content

Commit 21a9392

Browse files
committed
Minor docstring fix.
svn path=/trunk/matplotlib/; revision=6364
1 parent 788f764 commit 21a9392

1 file changed

Lines changed: 12 additions & 12 deletions

File tree

lib/matplotlib/axes.py

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -6931,23 +6931,23 @@ def matshow(self, Z, **kwargs):
69316931

69326932
class SubplotBase:
69336933
"""
6934-
Base class for subplots, which are Axes instances with additional
6935-
methods to facilitate generating and manipulating a set of Axes
6936-
within a figure.
6934+
Base class for subplots, which are :class:`Axes` instances with
6935+
additional methods to facilitate generating and manipulating a set
6936+
of :class:`Axes` within a figure.
69376937
"""
69386938

69396939
def __init__(self, fig, *args, **kwargs):
69406940
"""
6941-
fig is a figure instance
6941+
*fig* is a :class:`matplotlib.figure.Figure` instance.
69426942
6943-
args is numRows, numCols, plotNum
6944-
where the array of subplots in the figure has dimensions
6945-
numRows, numCols, and where plotNum is the number of the
6946-
subplot being created. plotNum starts at 1 in the upper
6947-
right corner and increases to the right.
6943+
*args* is the tuple (*numRows*, *numCols*, *plotNum*), where
6944+
the array of subplots in the figure has dimensions *numRows*,
6945+
*numCols*, and where *plotNum* is the number of the subplot
6946+
being created. *plotNum* starts at 1 in the upper right
6947+
corner and increases to the right.
69486948
6949-
If numRows<=numCols<=plotNum<10, args can be the decimal
6950-
integer numRows*100 + numCols*10 + plotNum.
6949+
If *numRows* <= *numCols* <= *plotNum* < 10, *args* can be the
6950+
decimal integer *numRows* * 100 + *numCols* * 10 + *plotNum*.
69516951
"""
69526952

69536953
self.figure = fig
@@ -6982,7 +6982,7 @@ def get_geometry(self):
69826982

69836983
# COVERAGE NOTE: Never used internally or from examples
69846984
def change_geometry(self, numrows, numcols, num):
6985-
'change subplot geometry, eg from 1,1,1 to 2,2,3'
6985+
'change subplot geometry, eg. from 1,1,1 to 2,2,3'
69866986
self._rows = numrows
69876987
self._cols = numcols
69886988
self._num = num-1

0 commit comments

Comments
 (0)