Skip to content

Clean up some Event class docs. #20745

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
merged 2 commits into from
Sep 1, 2021
Merged

Conversation

QuLogic
Copy link
Member

@QuLogic QuLogic commented Jul 27, 2021

PR Summary

The main thing was removing the __init__ docstrings, which appear oddly, and should be integrated into the descriptions. Then some minor cleanup to duplicate sentences, and formatting.

PR Checklist

  • [n/a] Has pytest style unit tests (and pytest passes).
  • Is Flake 8 compliant (run flake8 on changed files to check).
  • [n/a] New features are documented, with examples if plot related.
  • Documentation is sphinx and numpydoc compliant (the docs should build without error).
  • Conforms to Matplotlib style conventions (install flake8-docstrings and run flake8 --docstring-convention=all).
  • [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).

Copy link
Member

@jklymak jklymak left a comment

Choose a reason for hiding this comment

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

Just a couple of small suggestions.

@tacaswell tacaswell added this to the v3.5.0 milestone Aug 6, 2021
Copy link
Member

@tacaswell tacaswell left a comment

Choose a reason for hiding this comment

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

Up to @QuLogic to make my edit or not. Can self-merge in either case.

QuLogic and others added 2 commits August 25, 2021 18:26
Co-authored-by: Jody Klymak <jklymak@gmail.com>
Co-authored-by: Thomas A Caswell <tcaswell@gmail.com>
@dstansby dstansby merged commit a142369 into matplotlib:master Sep 1, 2021
meeseeksmachine pushed a commit to meeseeksmachine/matplotlib that referenced this pull request Sep 1, 2021
@QuLogic QuLogic deleted the event-docs branch September 1, 2021 19:13
QuLogic added a commit that referenced this pull request Sep 1, 2021
…745-on-v3.5.x

Backport PR #20745 on branch v3.5.x (Clean up some Event class docs.)
tacaswell pushed a commit that referenced this pull request Oct 20, 2021
Clean up some Event class docs.
ericpre pushed a commit to ericpre/matplotlib that referenced this pull request Oct 20, 2021
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.

4 participants