Merge pull request #20135 from AkM-2018/add_docs

jklymak · web-flow · commit 842f1e6857b1 · 2021-05-03T07:20:19.000-07:00
Add tricontour/tricontourf arguments(corner_mask, vmin vmax, antialiased, nchunk, hatches) documentation
diff --git a/lib/matplotlib/tri/tricontour.py b/lib/matplotlib/tri/tricontour.py
@@ -164,6 +164,13 @@ def _contour_args(self, args, kwargs):
 
 Other Parameters
 ----------------
+corner_mask : bool, default: :rc:`contour.corner_mask`
+    Enable/disable corner masking, which only has an effect if *Z* is
+    a masked array.  If ``False``, any quad touching a masked point is
+    masked out.  If ``True``, only the triangular corners of quads
+    nearest those points are always masked out, other triangular
+    corners comprising three unmasked points are contoured as usual.
+
 colors : color string or sequence of colors, optional
     The colors of the levels, i.e., the contour %(type)s.
 
@@ -191,6 +198,11 @@ def _contour_args(self, args, kwargs):
     the canonical colormap range [0, 1] for mapping to colors. If not given,
     the default linear scaling is used.
 
+vmin, vmax : float, optional
+    If not *None*, either or both of these values will be supplied to
+    the `.Normalize` instance, overriding the default color scaling
+    based on *levels*.
+
 origin : {*None*, 'upper', 'lower', 'image'}, default: None
     Determines the orientation and exact position of *Z* by specifying the
     position of ``Z[0, 0]``.  This is only relevant, if *X*, *Y* are not given.
@@ -239,7 +251,21 @@ def _contour_args(self, args, kwargs):
 
 xunits, yunits : registered units, optional
     Override axis units by specifying an instance of a
-    :class:`matplotlib.units.ConversionInterface`.""")
+    :class:`matplotlib.units.ConversionInterface`.
+
+antialiased : bool, optional
+    Enable antialiasing, overriding the defaults.  For
+    filled contours, the default is *True*.  For line contours,
+    it is taken from :rc:`lines.antialiased`.
+
+nchunk : int >= 0, optional
+    If 0, no subdivision of the domain.  Specify a positive integer to
+    divide the domain into subdomains of *nchunk* by *nchunk* quads.
+    Chunking reduces the maximum length of polygons generated by the
+    contouring algorithm which reduces the rendering workload passed
+    on to the backend and also requires slightly less RAM.  It can
+    however introduce rendering artifacts at chunk boundaries depending
+    on the backend, the *antialiased* flag and value of *alpha*.""")
 
 
 @docstring.Substitution(func='tricontour', type='lines')
@@ -277,8 +303,11 @@ def tricontourf(ax, *args, **kwargs):
     """
     %(_tricontour_doc)s
 
-    antialiased : bool, default: True
-        Whether to use antialiasing.
+    hatches : list[str], optional
+        A list of cross hatch patterns to use on the filled areas.
+        If None, no hatching will be added to the contour.
+        Hatching is supported in the PostScript, PDF, SVG and Agg
+        backends only.
 
     Notes
     -----
