Commit563eee5

authored

Merge pull request#30131 from timhoffm/doc-normalize-properties

DOC: Document the properties of Normalize

2 parentsb09a0c7 +1426f6a commit563eee5Copy full SHA for 563eee5

File tree

-0

lines changed

-0

lines changed

Lines changed: 7 additions & 0 deletions

Original file line number	Diff line number	Diff line change
`@@ -2315,6 +2315,7 @@ def __init__(self, vmin=None, vmax=None, clip=False):`
`2315`	`2315`
`2316`	`2316`	`@property`
`2317`	`2317`	`defvmin(self):`
	`2318`	`+"""Lower limit of the input data interval; maps to 0."""`
`2318`	`2319`	`returnself._vmin`
`2319`	`2320`
`2320`	`2321`	`@vmin.setter`
`@@ -2326,6 +2327,7 @@ def vmin(self, value):`
`2326`	`2327`
`2327`	`2328`	`@property`
`2328`	`2329`	`defvmax(self):`
	`2330`	`+"""Upper limit of the input data interval; maps to 1."""`
`2329`	`2331`	`returnself._vmax`
`2330`	`2332`
`2331`	`2333`	`@vmax.setter`
`@@ -2337,6 +2339,11 @@ def vmax(self, value):`
`2337`	`2339`
`2338`	`2340`	`@property`
`2339`	`2341`	`defclip(self):`
	`2342`	`+"""`
	`2343`	+ Determines the behavior for mapping values outside the range ``[vmin, vmax]``.
	`2344`	`+`
	`2345`	+ See the clip parameter in `.Normalize`.
	`2346`	`+ """`
`2340`	`2347`	`returnself._clip`
`2341`	`2348`
`2342`	`2349`	`@clip.setter`

Comments

(0)