From 00811136f788bd0cdf45749e8735fe98899f3ffb Mon Sep 17 00:00:00 2001 From: AkM-2018 Date: Sun, 2 May 2021 22:48:27 +0530 Subject: [PATCH 1/3] Add missing tricontour parameter documentation --- lib/matplotlib/tri/tricontour.py | 37 +++++++++++++++++++++++++++++--- 1 file changed, 34 insertions(+), 3 deletions(-) diff --git a/lib/matplotlib/tri/tricontour.py b/lib/matplotlib/tri/tricontour.py index 91fffcaa221c..d1f6900573a4 100644 --- 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,23 @@ 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 +305,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 ----- From 887e2fc89f8811e1b2fff9b7fd764b39c302d8ce Mon Sep 17 00:00:00 2001 From: AkM-2018 Date: Sun, 2 May 2021 22:56:26 +0530 Subject: [PATCH 2/3] Add missing tricontour parameter documentation --- lib/matplotlib/tri/tricontour.py | 1 - 1 file changed, 1 deletion(-) diff --git a/lib/matplotlib/tri/tricontour.py b/lib/matplotlib/tri/tricontour.py index d1f6900573a4..03f1f57cb825 100644 --- a/lib/matplotlib/tri/tricontour.py +++ b/lib/matplotlib/tri/tricontour.py @@ -253,7 +253,6 @@ def _contour_args(self, args, kwargs): Override axis units by specifying an instance of a :class:`matplotlib.units.ConversionInterface`. - antialiased : bool, optional Enable antialiasing, overriding the defaults. For filled contours, the default is *True*. For line contours, From 4363ce54ad764537da7f339a44bab565197b3a46 Mon Sep 17 00:00:00 2001 From: AkM-2018 Date: Mon, 3 May 2021 11:38:08 +0530 Subject: [PATCH 3/3] Remove extra newline --- lib/matplotlib/tri/tricontour.py | 1 - 1 file changed, 1 deletion(-) diff --git a/lib/matplotlib/tri/tricontour.py b/lib/matplotlib/tri/tricontour.py index 03f1f57cb825..297d457009ac 100644 --- a/lib/matplotlib/tri/tricontour.py +++ b/lib/matplotlib/tri/tricontour.py @@ -268,7 +268,6 @@ def _contour_args(self, args, kwargs): on the backend, the *antialiased* flag and value of *alpha*.""") - @docstring.Substitution(func='tricontour', type='lines') @docstring.dedent_interpd def tricontour(ax, *args, **kwargs):