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

DOC: Clarify Coords Report Example #21745

Merged
merged 1 commit into from
Nov 25, 2021
Merged

DOC: Clarify Coords Report Example #21745

merged 1 commit into from
Nov 25, 2021

Conversation

StefRe
Copy link
Contributor

@StefRe StefRe commented Nov 25, 2021

  • add remark that this only pertains to the interactive backend
  • PEP8 fixes

PR Summary

The coord reports example prominently shows the plot produced by the example. This can be a bit midleading as the demonstrated feature is only visible in the interactive backend. As this can lead to some confusion (see e.g. #2205), I added a short explanatory remark.
(the same pertains to the modifying the coordinate formatter example)

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
[N/A] New features are documented, with examples if plot related.
[N/A] New features have an entry in doc/users/next_whats_new/ (follow instructions in README.rst there).
[N/A] 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).

Copy link

@github-actions github-actions bot left a comment

Choose a reason for hiding this comment

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

Thank you for opening your first PR into Matplotlib!

If you have not heard from us in a while, please feel free to ping @matplotlib/developers or anyone who has commented on the PR. Most of our reviewers are volunteers and sometimes things fall through the cracks.

You can also join us on gitter for real-time discussion.

For details on testing, writing docs, and our review process, please see the developer guide

We strive to be a welcoming and open project. Please follow our Code of Conduct.

@jklymak jklymak added this to the v3.6.0 milestone Nov 25, 2021
- add remark that this only pertains to the interactive backend
- PEP8 fixes
@timhoffm timhoffm merged commit c072e3a into matplotlib:main Nov 25, 2021
@timhoffm
Copy link
Member

Thanks, and congratulations on your first contribution to matplotlib. We'd be happy to see you back.

@StefRe StefRe deleted the patch-1 branch November 25, 2021 20:48
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.

None yet

4 participants