From 3d1aa6e83c2c0671cc7385df87f9810c5e06b95d Mon Sep 17 00:00:00 2001 From: Tim Hoffmann <2836374+timhoffm@users.noreply.github.com> Date: Mon, 4 Nov 2024 00:20:23 +0100 Subject: [PATCH] DOC: Update docstring of triplot() --- lib/matplotlib/tri/_tripcolor.py | 22 +++++++++++++++++++--- 1 file changed, 19 insertions(+), 3 deletions(-) diff --git a/lib/matplotlib/tri/_tripcolor.py b/lib/matplotlib/tri/_tripcolor.py index 1ac6c48a2d7c..73c445efdd17 100644 --- a/lib/matplotlib/tri/_tripcolor.py +++ b/lib/matplotlib/tri/_tripcolor.py @@ -1,10 +1,11 @@ import numpy as np -from matplotlib import _api +from matplotlib import _api, _docstring from matplotlib.collections import PolyCollection, TriMesh from matplotlib.tri._triangulation import Triangulation +@_docstring.interpd def tripcolor(ax, *args, alpha=1.0, norm=None, cmap=None, vmin=None, vmax=None, shading='flat', facecolors=None, **kwargs): """ @@ -54,8 +55,23 @@ def tripcolor(ax, *args, alpha=1.0, norm=None, cmap=None, vmin=None, values used for each triangle are from the mean c of the triangle's three points. If *shading* is 'gouraud' then color values must be defined at points. - other_parameters - All other parameters are the same as for `~.Axes.pcolor`. + %(cmap_doc)s + + %(norm_doc)s + + %(vmin_vmax_doc)s + + %(colorizer_doc)s + + Returns + ------- + `~matplotlib.collections.PolyCollection` + + Other Parameters + ---------------- + **kwargs : `~matplotlib.collection.Collection` properties + + %(Collection:kwdoc)s """ _api.check_in_list(['flat', 'gouraud'], shading=shading)