Thanks to visit codestin.com
Credit goes to github.com

Skip to content

Commit 1426f6a

Browse files
committed
DOC: Document the properties of Normalize
1 parent 6083ecd commit 1426f6a

File tree

1 file changed

+7
-0
lines changed

1 file changed

+7
-0
lines changed

lib/matplotlib/colors.py

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2315,6 +2315,7 @@ def __init__(self, vmin=None, vmax=None, clip=False):
23152315

23162316
@property
23172317
def vmin(self):
2318+
"""Lower limit of the input data interval; maps to 0."""
23182319
return self._vmin
23192320

23202321
@vmin.setter
@@ -2326,6 +2327,7 @@ def vmin(self, value):
23262327

23272328
@property
23282329
def vmax(self):
2330+
"""Upper limit of the input data interval; maps to 1."""
23292331
return self._vmax
23302332

23312333
@vmax.setter
@@ -2337,6 +2339,11 @@ def vmax(self, value):
23372339

23382340
@property
23392341
def clip(self):
2342+
"""
2343+
Determines the behavior for mapping values outside the range ``[vmin, vmax]``.
2344+
2345+
See the *clip* parameter in `.Normalize`.
2346+
"""
23402347
return self._clip
23412348

23422349
@clip.setter

0 commit comments

Comments
 (0)