Skip to content

Improve the marker table in markers_api documentation #7499

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 4 commits into from
Dec 2, 2016
Merged

Improve the marker table in markers_api documentation #7499

Changes from 1 commit
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
0865b99
Fix wrong direction curly quotes in marker table, fit the (numsides, …
trpham Nov 22, 2016
3c4f845
Remove from table
trpham Nov 22, 2016
c5a8b6b
Add missing markers 'P' and 'X'
trpham Nov 28, 2016
fb2ebb2
Group 'P' and 'X' with the lower case versions
trpham Nov 29, 2016
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
Prev Previous commit
Next Next commit
Add missing markers 'P' and 'X'
  • Loading branch information
@trpham
trpham committed Nov 29, 2016
commit c5a8b6b5474c82f765802315f25f7dd934d490c5
20 changes: 11 additions & 9 deletions lib/matplotlib/markers.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,12 +25,14 @@
`"*"` star
`"h"` hexagon1
`"H"` hexagon2
`"+"` plus (filled)
`"x"` x (filled)
`"+"` plus
`"x"` x
`"D"` diamond
`"d"` thin_diamond
`"|"` vline
`"_"` hline
`"P"` plus (filled)
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Keep them together with the non-filled versions?

It may also make sense to reorder the entries a bit (say square / pentagon / hexagon1/2 / octogon) for example. Also, what is the difference between the two hexagons? Orientation I guess?

`"X"` x (filled)
TICKLEFT tickleft
TICKRIGHT tickright
TICKUP tickup
Expand All @@ -42,15 +44,11 @@
CARETLEFTBASE caretleft (centered at base)
CARETRIGHTBASE caretright (centered at base)
CARETUPBASE caretup (centered at base)
`" "`, or `""` nothing
`"None"`, `" "` or `""` nothing
``'$...$'`` render the string using mathtext.
`verts` a list of (x, y) pairs used for Path vertices.
The center of the marker is located at (0,0) and
the size is normalized. For backward
compatibility, the form (`verts`, 0) is also
accepted, but it is equivalent to just `verts`
for giving a raw set of vertices that define the
shape.
the size is normalized.
path a `~matplotlib.path.Path` instance.
(`numsides`, `style`, `angle`) The marker can also be a tuple (`numsides`,
`style`, `angle`), which will create a custom,
Expand All @@ -75,7 +73,11 @@
the angle of rotation of the symbol
============================== ===============================================

`None` is the default which often means 'nothing', however this table is
For backward compatibility, the form (`verts`, 0) is also accepted,
but it is 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