From f3441fbf7b104ee9ab031f1b1368cd34a1733786 Mon Sep 17 00:00:00 2001 From: Antony Lee Date: Sun, 8 Dec 2019 01:04:54 +0100 Subject: [PATCH] Update markers docs. Remove mention of APIs removed in 3.2 (`(verts, 0)` and `(numsides, 3, angle)`); small rewordings. --- lib/matplotlib/markers.py | 29 ++++++----------------------- 1 file changed, 6 insertions(+), 23 deletions(-) diff --git a/lib/matplotlib/markers.py b/lib/matplotlib/markers.py index e051047e57fc..a2669c0d9296 100644 --- a/lib/matplotlib/markers.py +++ b/lib/matplotlib/markers.py @@ -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'.