Skip to content

Commit 0081113

Browse files
committed
Add missing tricontour parameter documentation
1 parent 363105b commit 0081113

File tree

1 file changed

+34
-3
lines changed

1 file changed

+34
-3
lines changed

lib/matplotlib/tri/tricontour.py

Lines changed: 34 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -164,6 +164,13 @@ def _contour_args(self, args, kwargs):
164164
165165
Other Parameters
166166
----------------
167+
corner_mask : bool, default: :rc:`contour.corner_mask`
168+
Enable/disable corner masking, which only has an effect if *Z* is
169+
a masked array. If ``False``, any quad touching a masked point is
170+
masked out. If ``True``, only the triangular corners of quads
171+
nearest those points are always masked out, other triangular
172+
corners comprising three unmasked points are contoured as usual.
173+
167174
colors : color string or sequence of colors, optional
168175
The colors of the levels, i.e., the contour %(type)s.
169176
@@ -191,6 +198,11 @@ def _contour_args(self, args, kwargs):
191198
the canonical colormap range [0, 1] for mapping to colors. If not given,
192199
the default linear scaling is used.
193200
201+
vmin, vmax : float, optional
202+
If not *None*, either or both of these values will be supplied to
203+
the `.Normalize` instance, overriding the default color scaling
204+
based on *levels*.
205+
194206
origin : {*None*, 'upper', 'lower', 'image'}, default: None
195207
Determines the orientation and exact position of *Z* by specifying the
196208
position of ``Z[0, 0]``. This is only relevant, if *X*, *Y* are not given.
@@ -239,7 +251,23 @@ def _contour_args(self, args, kwargs):
239251
240252
xunits, yunits : registered units, optional
241253
Override axis units by specifying an instance of a
242-
:class:`matplotlib.units.ConversionInterface`.""")
254+
:class:`matplotlib.units.ConversionInterface`.
255+
256+
257+
antialiased : bool, optional
258+
Enable antialiasing, overriding the defaults. For
259+
filled contours, the default is *True*. For line contours,
260+
it is taken from :rc:`lines.antialiased`.
261+
262+
nchunk : int >= 0, optional
263+
If 0, no subdivision of the domain. Specify a positive integer to
264+
divide the domain into subdomains of *nchunk* by *nchunk* quads.
265+
Chunking reduces the maximum length of polygons generated by the
266+
contouring algorithm which reduces the rendering workload passed
267+
on to the backend and also requires slightly less RAM. It can
268+
however introduce rendering artifacts at chunk boundaries depending
269+
on the backend, the *antialiased* flag and value of *alpha*.""")
270+
243271

244272

245273
@docstring.Substitution(func='tricontour', type='lines')
@@ -277,8 +305,11 @@ def tricontourf(ax, *args, **kwargs):
277305
"""
278306
%(_tricontour_doc)s
279307
280-
antialiased : bool, default: True
281-
Whether to use antialiasing.
308+
hatches : list[str], optional
309+
A list of cross hatch patterns to use on the filled areas.
310+
If None, no hatching will be added to the contour.
311+
Hatching is supported in the PostScript, PDF, SVG and Agg
312+
backends only.
282313
283314
Notes
284315
-----

0 commit comments

Comments
 (0)