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

Skip to content

Commit 6435fbf

Browse files
committed
DOC: Clarify Artist.set() behavior
1 parent 51fbfc4 commit 6435fbf

1 file changed

Lines changed: 8 additions & 2 deletions

File tree

lib/matplotlib/artist.py

Lines changed: 8 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -169,6 +169,7 @@ def _update_set_signature_and_docstring(cls):
169169
Set multiple properties at once.
170170
171171
::
172+
172173
a.set(a=A, b=B, c=C)
173174
174175
is equivalent to ::
@@ -177,8 +178,13 @@ def _update_set_signature_and_docstring(cls):
177178
a.set_b(B)
178179
a.set_c(C)
179180
180-
The order of operations is not guaranteed, however most properties do not
181-
depend on each other.
181+
In addition to the full property names, aliases are also supported, e.g.
182+
``set(lw=2)`` is equivalent to ``set(linewidth=2)``, but it is an error
183+
to pass both simultaneously.
184+
185+
The order of the individual setter calls matches the order of parameters
186+
in ``set()``. However, most properties do not depend on each other so
187+
that order is rarely relevant.
182188
183189
Supported properties are
184190

0 commit comments

Comments
 (0)