Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly

Appearance settings

Commit 460377d

Browse filesBrowse files
committed
Cleanups to contour docs.
More could be done, but let's take things a bit at a time.
1 parent fc8a2fa commit 460377d
Copy full SHA for 460377d

File tree

Expand file treeCollapse file tree

1 file changed

+8
-13
lines changed
Filter options
Expand file treeCollapse file tree

1 file changed

+8
-13
lines changed

‎lib/matplotlib/contour.py

Copy file name to clipboardExpand all lines: lib/matplotlib/contour.py
+8-13Lines changed: 8 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -68,7 +68,7 @@ def clabel(self, levels=None, *,
6868
Size in points or relative size e.g., 'smaller', 'x-large'.
6969
See `.Text.set_size` for accepted string values.
7070
71-
colors : color-spec, optional
71+
colors : color or colors or None, default: None
7272
The label colors:
7373
7474
- If *None*, the color of each label matches the color of
@@ -99,7 +99,7 @@ def clabel(self, levels=None, *,
9999
`.Formatter` instance, that returns a string when called with a
100100
numeric contour level.
101101
102-
manual : bool or iterable, optional
102+
manual : bool or iterable, default: False
103103
If ``True``, contour labels will be placed manually using
104104
mouse clicks. Click the first button near a contour to
105105
add a label, click the second button (or potentially both
@@ -124,12 +124,9 @@ def clabel(self, levels=None, *,
124124
of texts during the drawing time, therefore this can be used if
125125
aspect of the axes changes.
126126
127-
zorder : float or None, optional
127+
zorder : float or None, default: ``(2 + contour.get_zorder())``
128128
zorder of the contour labels.
129129
130-
If not specified, the zorder of contour labels is set to
131-
(2 + zorder of contours).
132-
133130
Returns
134131
-------
135132
labels
@@ -1017,8 +1014,7 @@ def _process_args(self, *args, **kwargs):
10171014
"""
10181015
Process *args* and *kwargs*; override in derived classes.
10191016
1020-
Must set self.levels, self.zmin and self.zmax, and update axes
1021-
limits.
1017+
Must set self.levels, self.zmin and self.zmax, and update axes limits.
10221018
"""
10231019
self.levels = args[0]
10241020
self.allsegs = args[1]
@@ -1613,10 +1609,9 @@ def _initialize_x_y(self, z):
16131609
levels : int or array-like, optional
16141610
Determines the number and positions of the contour lines / regions.
16151611
1616-
If an int *n*, use an algorithm
1617-
(see `~matplotlib.ticker.MaxNLocator`) that tries to provide
1618-
no more than *n+1* "nice" contour levels between vmin and vmax.
1619-
The level heights are automatically chosen.
1612+
If an int *n*, use `~matplotlib.ticker.MaxNLocator`, which tries
1613+
to automatically choose no more than *n+1* "nice" contour levels
1614+
between *vmin* and *vmax*.
16201615
16211616
If array-like, draw contour lines at the specified levels.
16221617
The values must be in increasing order.
@@ -1668,7 +1663,7 @@ def _initialize_x_y(self, z):
16681663
the `.Normalize` instance, overriding the default color scaling
16691664
based on *levels*.
16701665
1671-
origin : {*None*, 'upper', 'lower', 'image'}, optional
1666+
origin : {*None*, 'upper', 'lower', 'image'}, default: None
16721667
Determines the orientation and exact position of *Z* by specifying
16731668
the position of ``Z[0, 0]``. This is only relevant, if *X*, *Y*
16741669
are not given.

0 commit comments

Comments
0 (0)
Morty Proxy This is a proxified and sanitized view of the page, visit original site.