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 ec95510

Browse filesBrowse files
timhoffmmeeseeksmachine
authored andcommitted
Backport PR #29065: DOC: Update docstring of triplot()
1 parent 10e09bf commit ec95510
Copy full SHA for ec95510

File tree

Expand file treeCollapse file tree

1 file changed

+21
-3
lines changed
Filter options
Expand file treeCollapse file tree

1 file changed

+21
-3
lines changed

‎lib/matplotlib/tri/_tripcolor.py

Copy file name to clipboardExpand all lines: lib/matplotlib/tri/_tripcolor.py
+21-3Lines changed: 21 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,11 @@
11
import numpy as np
22

3-
from matplotlib import _api
3+
from matplotlib import _api, _docstring
44
from matplotlib.collections import PolyCollection, TriMesh
55
from matplotlib.tri._triangulation import Triangulation
66

77

8+
@_docstring.interpd
89
def tripcolor(ax, *args, alpha=1.0, norm=None, cmap=None, vmin=None,
910
vmax=None, shading='flat', facecolors=None, **kwargs):
1011
"""
@@ -54,8 +55,25 @@ def tripcolor(ax, *args, alpha=1.0, norm=None, cmap=None, vmin=None,
5455
values used for each triangle are from the mean c of the triangle's
5556
three points. If *shading* is 'gouraud' then color values must be
5657
defined at points.
57-
other_parameters
58-
All other parameters are the same as for `~.Axes.pcolor`.
58+
%(cmap_doc)s
59+
60+
%(norm_doc)s
61+
62+
%(vmin_vmax_doc)s
63+
64+
%(colorizer_doc)s
65+
66+
Returns
67+
-------
68+
`~matplotlib.collections.PolyCollection` or `~matplotlib.collections.TriMesh`
69+
The result depends on *shading*: For ``shading='flat'`` the result is a
70+
`.PolyCollection`, for ``shading='gouraud'`` the result is a `.TriMesh`.
71+
72+
Other Parameters
73+
----------------
74+
**kwargs : `~matplotlib.collections.Collection` properties
75+
76+
%(Collection:kwdoc)s
5977
"""
6078
_api.check_in_list(['flat', 'gouraud'], shading=shading)
6179

0 commit comments

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