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.

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

Conversation

trpham
Copy link
Contributor

@trpham trpham commented Nov 22, 2016

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

@anntzer
Copy link
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?

@tacaswell
Copy link
Member

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'.

@tacaswell tacaswell added this to the 2.0 (style change major release) milestone Nov 22, 2016
@trpham trpham force-pushed the 7342-Improve-Markers-api-documentation branch from d7ac421 to f1f8d41 Compare November 22, 2016 19:29
None nothing
" " nothing
"" nothing
`" "`, or `""` nothing
Copy link
Member

Choose a reason for hiding this comment

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

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

``'$...$'`` 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
Copy link
Member

Choose a reason for hiding this comment

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

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

`"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?

@trpham trpham force-pushed the 7342-Improve-Markers-api-documentation branch from 7e1f1bc to fb2ebb2 Compare November 29, 2016 19:39
@NelleV NelleV changed the title Improve the the marker table in markers_api documentation [MRG] Improve the the marker table in markers_api documentation Nov 29, 2016
@tacaswell
Copy link
Member

appveyor failures look unrelated.

@NelleV
Copy link
Member

NelleV commented Dec 2, 2016

Thanks @trpham for your hard work this semester!

@NelleV NelleV merged commit dfd38f7 into matplotlib:master Dec 2, 2016
@Kojoley Kojoley changed the title [MRG] Improve the the marker table in markers_api documentation Improve the the marker table in markers_api documentation Dec 5, 2016
QuLogic pushed a commit that referenced this pull request Dec 7, 2016
…tation

Improve the the marker table in markers_api documentation
@QuLogic
Copy link
Member

QuLogic commented Dec 7, 2016

Backported to v2.x as 16545df.

@tacaswell tacaswell changed the title Improve the the marker table in markers_api documentation 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
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants