Improve the marker table in markers_api documentation #7499

Merged
merged 4 commits into from Dec 2, 2016

Conversation

Projects
5 participants
Contributor

trpham commented Nov 22, 2016 edited

Prefer to this issue: #7342

Improve the current page: http://matplotlib.org/devdocs/api/markers_api.html. as below:

  • Fixed the wrong directional curly quotes by adding backquotes.
  • Grouped the marker implies "nothing" together.
  • Fit the (numsides, style, angle) entry and its description inside the table.

markers matplotlib 2 0 0b4 2985 gc5a8b6b dirty documentation google chrome today at 11 25 01 am


markers matplotlib 2 0 0b4 2985 gc5a8b6b dirty documentation google chrome today at 11 25 16 am

Contributor

anntzer commented Nov 22, 2016

I would fold the "(verts, 0)" form together with "verts". Also, did you figure out what all the TICKs and CARETs are about?

Owner

tacaswell commented Nov 22, 2016

Can you remove None from the table and add it back as a note under the table? None is the default which is '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', but may not be 'nothing'.

lib/matplotlib/markers.py
-None nothing
-" " nothing
-"" nothing
+`" "`, or `""` nothing
@tacaswell

tacaswell Nov 23, 2016

Owner

This still needs to include the string 'None' (distinct from the object None)

lib/matplotlib/markers.py
``'$...$'`` 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.
+ the size is normalized. For backward
@tacaswell

tacaswell Nov 23, 2016

Owner

Leave this comment at the bottom, no need to draw attention to it.

lib/matplotlib/markers.py
`"D"` diamond
`"d"` thin_diamond
`"|"` vline
`"_"` hline
+`"P"` plus (filled)
@anntzer

anntzer Nov 28, 2016

Contributor

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?

trpham added some commits Nov 22, 2016

@trpham trpham Fix wrong direction curly quotes in marker table, fit the (numsides, …
…style, angle) description inside the table, group 'nothing' marker
0865b99
@trpham trpham Remove from table 3c4f845
@trpham trpham Add missing markers 'P' and 'X' c5a8b6b
@trpham trpham Group 'P' and 'X' with the lower case versions
fb2ebb2

NelleV changed the title from Improve the the marker table in markers_api documentation to [MRG] Improve the the marker table in markers_api documentation Nov 29, 2016

Owner

tacaswell commented Dec 2, 2016

appveyor failures look unrelated.

Contributor

NelleV commented Dec 2, 2016

Thanks @trpham for your hard work this semester!

@NelleV NelleV merged commit dfd38f7 into matplotlib:master Dec 2, 2016

2 of 3 checks passed

continuous-integration/appveyor/pr AppVeyor build failed
Details
continuous-integration/travis-ci/pr The Travis CI build passed
Details
coverage/coveralls Coverage remained the same at 61.886%
Details

Kojoley changed the title from [MRG] Improve the the marker table in markers_api documentation to Improve the the marker table in markers_api documentation Dec 5, 2016

@QuLogic QuLogic added a commit that referenced this pull request Dec 7, 2016

@NelleV @QuLogic NelleV + QuLogic Merge pull request #7499 from trpham/7342-Improve-Markers-api-documen…
…tation

Improve the the marker table in markers_api documentation
16545df
Member

QuLogic commented Dec 7, 2016

Backported to v2.x as 16545df.

tacaswell changed the title from Improve the the marker table in markers_api documentation to Improve the marker table in markers_api documentation Jun 3, 2017

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment