Skip to content

Improve linestyle documentation #11908

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

Closed
timhoffm opened this issue Aug 21, 2018 · 5 comments
Closed

Improve linestyle documentation #11908

timhoffm opened this issue Aug 21, 2018 · 5 comments
Milestone

Comments

@timhoffm
Copy link
Member

We currently have

https://matplotlib.org/gallery/lines_bars_and_markers/line_styles_reference.html
https://matplotlib.org/gallery/lines_bars_and_markers/linestyles.html

which are partly redundant. Also one of them uses the (offset, on-off-dash-seq) but does not explain it.

This should be merged in to a single comprehensible file with a bit more explanation.

See also:
https://matplotlib.org/api/_as_gen/matplotlib.lines.Line2D.html#matplotlib.lines.Line2D.set_linestyle
(which itself is not in great shape)

@timhoffm timhoffm added Documentation Good first issue Open a pull request against these issues if there are no active ones! labels Aug 21, 2018
@tacaswell tacaswell added this to the v3.1 milestone Aug 23, 2018
@tacaswell
Copy link
Member

Is this fully addressed by #11909?

@timhoffm
Copy link
Member Author

timhoffm commented Aug 23, 2018

No. #11909 just slightly simplifies the code of each of the examples.

I'm proposing here to join the two examples and add a bit of explanatory text.

@ImportanceOfBeingErnest
Copy link
Member

In #11797 I compared the different ways to set linestyle and there seem to be a couple of inconsistencies and missing options. So getting clear about which option/syntax can be used where would also help (re)writing the examples.

@thoo
Copy link
Contributor

thoo commented Oct 17, 2018

I am a new comer and would like to work on this. Would this be a good place to start? Thanks.

@timhoffm
Copy link
Member Author

Yes, particularly "Writing examples and tutorials".

@timhoffm timhoffm removed the Good first issue Open a pull request against these issues if there are no active ones! label Oct 30, 2018
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

4 participants