10BC0 Update MarkerStyle.set_marker and __init__ docs · matplotlib/matplotlib@514c118 · GitHub
[go: up one dir, main page]

Skip to content

Commit 514c118

Browse files
committed
Update MarkerStyle.set_marker and __init__ docs
- Mention errorbar in the module docs. - Add details of the copy constructor.
1 parent 9efef4e commit 514c118

File tree

1 file changed

+15
-7
lines changed

1 file changed

+15
-7
lines changed

lib/matplotlib/markers.py

Lines changed: 15 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
r"""
22
Functions to handle markers; used by the marker functionality of
3-
`~matplotlib.axes.Axes.plot` and `~matplotlib.axes.Axes.scatter`.
3+
`~matplotlib.axes.Axes.plot`, `~matplotlib.axes.Axes.scatter`, and `~matplotlib.axes.Axes.errorbar`.
44
55
All possible markers are defined here:
66
@@ -216,9 +216,13 @@ def __init__(self, marker=None, fillstyle=None):
216216
"""
217217
Parameters
218218
----------
219-
marker : str or array-like or None, default: None
220-
*None* means no marker. For other possible marker values see the
221-
module docstring `matplotlib.markers`.
219+
marker : str, array-like, Path, MarkerStyle, or None, default: None
220+
221+
Another instance of *MarkerStyle* copies the details of that ``marker``.
222+
223+
*None* means no marker.
224+
225+
For other possible marker values see the module docstring `matplotlib.markers`.
222226
223227
fillstyle : str, default: 'full'
224228
One of 'full', 'left', 'right', 'bottom', 'top', 'none'.
@@ -283,9 +287,13 @@ def set_marker(self, marker):
283287
284288
Parameters
285289
----------
286-
marker : str or array-like or None, default: None
287-
*None* means no marker. For other possible marker values see the
288-
module docstring `matplotlib.markers`.
290+
marker : str, array-like, Path, MarkerStyle, or None, default: None
291+
292+
Another instance of *MarkerStyle* copies the details of that ``marker``.
293+
294+
*None* means no marker.
295+
296+
For other possible marker values see the module docstring `matplotlib.markers`.
289297
"""
290298
if (isinstance(marker, np.ndarray) and marker.ndim == 2 and
291299
marker.shape[1] == 2):

0 commit comments

Comments
 (0)
0