Skip to content

Commit 4f72962

Browse files
committed
updated docstrings in MultiNorm
1 parent 22e9093 commit 4f72962

File tree

1 file changed

+18
-8
lines changed

1 file changed

+18
-8
lines changed

lib/matplotlib/colors.py

Lines changed: 18 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -3459,8 +3459,10 @@ def inverse(self, values):
34593459
values : array-like
34603460
The input data, as an iterable or a structured numpy array.
34613461
3462-
- If iterable, must be of length `n_components`
3463-
- If structured array, must have `n_components` fields.
3462+
- If iterable, must be of length `n_components`. Each element can be a
3463+
scalar or array-like and is normalized through the correspong norm.
3464+
- If structured array, must have `n_components` fields. Each field
3465+
is normalized through the the corresponding norm.
34643466
34653467
"""
34663468
values = self._iterable_components_in_data(values, self.n_components)
@@ -3475,8 +3477,12 @@ def autoscale(self, A):
34753477
Parameters
34763478
----------
34773479
A : array-like
3478-
Data, must be of length `n_components` or be a structured scalar or
3479-
structured array with `n_components` fields.
3480+
The input data, as an iterable or a structured numpy array.
3481+
3482+
- If iterable, must be of length `n_components`. Each element
3483+
is used for the limits of one constituent norm.
3484+
- If structured array, must have `n_components` fields. Each field
3485+
is used for the limits of one constituent norm.
34803486
"""
34813487
with self.callbacks.blocked():
34823488
# Pause callbacks while we are updating so we only get
@@ -3493,9 +3499,13 @@ def autoscale_None(self, A):
34933499
34943500
Parameters
34953501
----------
3496-
A
3497-
Data, must be of length `n_components` or be a structured array
3498-
with `n_components` fields.
3502+
A : array-like
3503+
The input data, as an iterable or a structured numpy array.
3504+
3505+
- If iterable, must be of length `n_components`. Each element
3506+
is used for the limits of one constituent norm.
3507+
- If structured array, must have `n_components` fields. Each field
3508+
is used for the limits of one constituent norm.
34993509
"""
35003510
with self.callbacks.blocked():
35013511
A = self._iterable_components_in_data(A, self.n_components)
@@ -3512,7 +3522,7 @@ def _iterable_components_in_data(data, n_components):
35123522
"""
35133523
Provides an iterable over the components contained in the data.
35143524
3515-
An input array with `n_components` fields is returned as a list of length n
3525+
An input array with `n_components` fields is returned as a tuple of length n
35163526
referencing slices of the original array.
35173527
35183528
Parameters

0 commit comments

Comments
 (0)
pFad - Phonifier reborn

Pfad - The Proxy pFad of © 2024 Garber Painting. All rights reserved.

Note: This service is not intended for secure transactions such as banking, social media, email, or purchasing. Use at your own risk. We assume no liability whatsoever for broken pages.


Alternative Proxies:

Alternative Proxy

pFad Proxy

pFad v3 Proxy

pFad v4 Proxy