Skip to content
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

Update lines_with_ticks_demo.py #22034

Merged
merged 1 commit into from
Jan 5, 2022

Conversation

ruthgn
Copy link
Contributor

@ruthgn ruthgn commented Dec 22, 2021

PR Summary

Add explanatory comments to the example on creating lines with ticked patheffect. PR related to issue #11654.

PR Checklist

Tests and Styling

  • Has pytest style unit tests (and pytest passes).
  • Is Flake 8 compliant (install flake8-docstrings and run flake8 --docstring-convention=all).

Documentation

  • New features are documented, with examples if plot related.
  • New features have an entry in doc/users/next_whats_new/ (follow instructions in README.rst there).
  • API changes documented in doc/api/next_api_changes/ (follow instructions in README.rst there).
  • Documentation is sphinx and numpydoc compliant (the docs should build without error).

Add explanatory comments to the example on lines with ticked patheffect
@jklymak
Copy link
Member

jklymak commented Dec 24, 2021

I think this example already has a enough explanation. I don't agree that we need to tell a user that ax.plot([0, 1], [0, 1]... will plot a straight line, or that sin(x) is a "curved line".

Copy link
Member

@dstansby dstansby left a comment

Choose a reason for hiding this comment

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

I don't think the comments detract from the example, and having a bit more structuring helps. I think the example could be improved/expanded, but that can be for another PR Thanks for this PR!

@dstansby dstansby added this to the v3.6.0 milestone Dec 28, 2021
@jklymak jklymak merged commit d8a90ae into matplotlib:main Jan 5, 2022
@ruthgn ruthgn deleted the explain_ticked_patheffect_example branch January 5, 2022 15:54
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.

3 participants