Clean up some Event class docs. #20745
Open
Conversation
| In addition to the `Event` and `LocationEvent` attributes, the below event | ||
| attributes are defined. |
Comment on lines
+1374
to
+1375
jklymak
Jul 27, 2021
Contributor
This still reads awkwardly. Maybe?
Suggested change
| In addition to the `Event` and `LocationEvent` attributes, the below event | |
| attributes are defined. | |
| A MouseEvent has a number of special attributes in addition to those defined by the parent `Event` and `LocationEvent` classes: |
QuLogic
Jul 27, 2021
Author
Member
Yea, even though numpydoc says the order for classes is the same as normal functions with Parameters replaced by Attributes, the Attributes appear after Examples. So I needed to tweak the wording, but it's still not great.
I'm not sure if it's numpydoc that's wrong, or if this is a theme bug.
|
Just a couple of small suggestions. |
Co-authored-by: Jody Klymak <jklymak@gmail.com>
| character ("g", "G", "#", etc.), a special key | ||
| ("control", "shift", "f1", "up", etc.) or a | ||
| combination of the above (e.g., "ctrl+alt+g", "ctrl+alt+G"). | ||
| The key(s) pressed. Could be *None*, a single case sensitive ASCII |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
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
pytestpasses).flake8on changed files to check).flake8-docstringsand 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).