Skip to content

Update markers docs. #15869

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Dec 8, 2019
Merged

Update markers docs. #15869

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
29 changes: 6 additions & 23 deletions lib/matplotlib/markers.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -55,31 +55,14 @@
normalized, such that the created path
is encapsulated inside the unit cell.
path A `~matplotlib.path.Path` instance.
``(numsides, style, angle)`` The marker can also be a tuple
``(numsides, style, angle)``, which
will create a custom, regular symbol.

``numsides``:
the number of sides

``style``:
the style of the regular symbol:

- 0: a regular polygon
- 1: a star-like symbol
- 2: an asterisk
- 3: a circle (``numsides`` and
``angle`` is ignored);
deprecated.

``angle``:
the angle of rotation of the symbol
``(numsides, 0, angle)`` A regular polygon with ``numsides``
sides, rotated by ``angle``.
``(numsides, 1, angle)`` A star-like symbol with ``numsides``
sides, rotated by ``angle``.
``(numsides, 2, angle)`` An asterisk with ``numsides`` sides,
rotated by ``angle``.
============================== ====== =========================================

For backward compatibility, the form ``(verts, 0)`` is also accepted, but it is
deprecated and equivalent to just ``verts`` for giving a raw set of vertices
that define the shape.

``None`` is the default which means 'nothing', however this table is
referred to from other docs for the valid inputs from marker inputs and in
those cases ``None`` still means 'default'.
Expand Down