8000 reworked set_markevery docstring to bullet list · matplotlib/matplotlib@6746bb4 · GitHub
[go: up one dir, main page]

Skip to content

Commit 6746bb4

Browse files
committed
reworked set_markevery docstring to bullet list
1 parent 93a2ad4 commit 6746bb4

File tree

1 file changed

+21
-15
lines changed

1 file changed

+21
-15
lines changed

lib/matplotlib/lines.py

Lines changed: 21 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -350,21 +350,27 @@ def set_markevery(self, every):
350350
----------
351351
every: None | int | length-2 tuple of int | slice | list/array of int |
352352
float | length-2 tuple of float
353-
Which markers to plot. If `every`=None, every point will be
354-
plotted. If every=`N`, every N-th marker will be plotted starting
355-
with marker 0. If `every`=(start, N), every N-th marker, starting
356-
at point start, will be plotted. If `every`=slice(start, end, N),
357-
every N-th marker, starting at point start, upto but not including
358-
point end, will be plotted. If every=[i, j, m, n], only markers at
359-
points i, j, m, and n will be plotted. If `every`=0.1, (i.e. a
360-
float) then markers will be spaced at approximately equal
361-
distances along the line; the distance along the line between
362-
markers is determined by multiplying the display-coordinate
363-
distance of the axes bounding-box diagonal by the value of `every`.
364-
For `every`=(0.5, 0.1) (i.e. a length-2 tuple of float), the same
365-
functionality as `every`=0.1 is exhibited but the first marker will
366-
be 0.5 multiplied by the display-cordinate-diagonal-distance along
367-
the line.
353+
Which markers to plot.
354+
355+
- If every=None, every point will be plotted.
356+
- If every=N, every N-th marker will be plotted starting with
357+
marker 0.
358+
- If every=(start, N), every N-th marker, starting at point
359+
start, will be plotted.
360+
- If every=slice(start, end, N), every N-th marker, starting at
361+
point start, upto but not including point end, will be plotted.
362+
- If every=[i, j, m, n], only markers at points i, j, m, and n
363+
will be plotted.
364+
- every=0.1, (i.e. a float) then markers will be spaced at
365+
approximately equal distances along the line; the distance
366+
along the line between markers is determined by multiplying the
367+
display-coordinate distance of the axes bounding-box diagonal
368+
by the value of every.
369+
- For every=(0.5, 0.1) (i.e. a length-2 tuple of float), the
370+
same functionality as every=0.1 is exhibited but the first
371+
marker will be 0.5 multiplied by the
372+
display-cordinate-diagonal-distance along the line.
373+
368374
369375
Notes
370376
-----

0 commit comments

Comments
 (0)
0