Uh oh!
There was an error while loading.Please reload this page.
- Notifications
You must be signed in to change notification settings - Fork7.9k
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 ourterms of service andprivacy statement. We’ll occasionally send you account related emails.
Already on GitHub?Sign in to your account
Uh oh!
There was an error while loading.Please reload this page.
Conversation
Uh oh!
There was an error while loading.Please reload this page.
Uh oh!
There was an error while loading.Please reload this page.
There was a problem hiding this 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.
Uh oh!
There was an error while loading.Please reload this page.
There was a problem hiding this 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.
Co-authored-by: Jody Klymak <jklymak@gmail.com>Co-authored-by: Thomas A Caswell <tcaswell@gmail.com>
…745-on-v3.5.xBackport PR#20745 on branch v3.5.x (Clean up some Event class docs.)
Clean up some Event class docs.
Clean up some Event class docs.
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
pytest
passes).flake8
on changed files to check).flake8-docstrings
and runflake8 --docstring-convention=all
).doc/users/next_whats_new/
(follow instructions in README.rst there).doc/api/next_api_changes/
(follow instructions in README.rst there).