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.

Sign up for GitHub

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

Jump to bottom

Tidy up the Event-related documentation #4302

Merged
merged 54 commits into from
Mar 20, 2024
Merged

Tidy up the Event-related documentation #4302

merged 54 commits into from
Mar 20, 2024

Conversation

davep
Copy link
Contributor

@davep davep commented Mar 18, 2024 •
edited
Loading

A PR that wanders through the Event-related docs and tidies up some issues. Main changes are:

  • Removes almost all of the in-md-file documentation for all documented events and instead relies on their docstrings.
  • Adds missing docstrings where appropriate.
  • Adds more see-also goodness where noticed and appropriate.
  • Adds Print to the documented events.
  • Adds AppBlur and AppFocus to the list of events now that they're more widely-used.

Fixes #4174.

davep added 14 commits March 18, 2024 09:52
@davep
De-duplicate the bubble and verbose checkboxen
b50c9dc 
Go with the ones that are provided in the event's docstring; it makes more
sense to go with that as the documentation is with the code, and so if
anything changes the maintainer is far more likely to remember to change it.
@davep
Add missing attribute table content to DescendantBlur docs
d5dfadc
@davep
Add missing attribute table content to DescendantFocus docs
b34c9ac
@davep
Update the documentation for the Key event
5bc0276
@davep
Tweak the documentation for MouseCapture
e421403
@davep
Tidy up the MouseDown event docs
298c100
@davep
Tidy up the MouseMove event docs
2fdccc8
@davep
Tweak the documentation for MouseRelease
5f1a836
@davep
Tidy up the MouseScrollDown event docs
bf07041
@davep
Tidy up the MouseScrollUp event docs
f442bbc
@davep
Tidy up the MouseUp event docs
58b0b1b
@davep
Tidy up the Paste event docs
e8c9c13
@davep
Tidy up the Resize event docs
016308d
@davep
Link MouseCapture and MouseRelease with see-alsos
eb396f0
@davep davep added documentation Improvements or additions to documentation Task labels Mar 18, 2024
@davep davep self-assigned this Mar 18, 2024
davep added 3 commits March 18, 2024 11:22
@davep
Add the Print event to the list of events in the reference
1f03c07
@davep
Sort the index of events
2b1088b
@davep
Add AppFocus and AppBlur to the events
a47be5a 
Now that they're supported by more than just textual-web it makes sense to
expose them a little better in the docs.
@davep davep marked this pull request as ready for review March 18, 2024 11:53
@davep davep marked this pull request as draft March 19, 2024 14:25
@davep
Copy link
Contributor Author

davep commented Mar 19, 2024

Taking back to draft for the moment. We've decided to go all-in on letting the events self-document (as much as is possible), so I'll go back over these gain and remove almost everything from the md files themselves, and also harmonise each of the events in terms of what has docstrings and what form they take.

davep added 23 commits March 20, 2024 10:56
@davep
Tidy the documentation for the Key event
9c33d85
@davep
Tidy the documentation for the Leave event
f1dcfff
@davep
Tidy the documentation for the Load event
e075fcb
@davep
Tidy the documentation for the Mount event
ff4ad4e
@davep
Tidy the documentation for the MouseCapture event
e5c5fe4
@davep
Tidy the documentation for the MouseDown event
d524f6c
@davep
Tidy the title for the MouseCapture event
9d53193
@davep
Tidy the documentation for the MouseMove event
80e3cff
@davep
Tidy the documentation for the MouseRelease event
5da3a12
@davep
Tidy the documentation for the MouseScrollDown event
a33b5c3
@davep
Tidy the documentation for the MouseScrollUp event
a1f09bb
@davep
Tidy the documentation for the MouseUp event
1d4fced
@davep
Tidy the documentation for the Paste event
d061d6f
@davep
Tidy the documentation for the Print event
e2df78c
@davep
Tidy the documentation for the Resize event
d99c684
@davep
Tidy the documentation for the ScreenResume event
411834f
@davep
Tidy the documentation for the ScreenSuspend event
19f2e3b
@davep
Tidy the documentation for the Show event
8d0edb1
@davep
Add a docstring to MouseCapture.mouse_position
96ef63a
@davep
Add a docstring to MouseRelease.mouse_position
fa40ec8
@davep
Ensure the Key event's attributes are documented
35ef9c8
@davep
Add docstrings to each of the MouseEvent attributes
bb4ec2d
@davep
Remove unnecessary Return sections from MouseEvent properties
ab2e790
@davep davep marked this pull request as ready for review March 20, 2024 14:49
TomJGooding
TomJGooding reviewed Mar 20, 2024
View reviewed changes
src/textual/events.py Outdated Show resolved Hide resolved
@davep @TomJGooding
Fix likely copy/paste-o
cd608c1 
Co-authored-by: TomJGooding <[email protected]>
willmcgugan
willmcgugan approved these changes Mar 20, 2024
View reviewed changes
Copy link
Collaborator

@willmcgugan willmcgugan left a comment

Choose a reason for hiding this comment

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

Works for me.

@davep davep merged commit 154a631 into Textualize:main Mar 20, 2024
20 checks passed
@davep davep deleted the event-docs-tidy branch March 20, 2024 15:12
@davep davep mentioned this pull request Mar 20, 2024
Closed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@TomJGooding TomJGooding TomJGooding left review comments

@willmcgugan willmcgugan willmcgugan approved these changes

@rodrigogiraoserrao rodrigogiraoserrao Awaiting requested review from rodrigogiraoserrao

Assignees

@davep davep

Labels
documentation Improvements or additions to documentation Task
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

Event documentation doubles up the bubble and verbose checkboxes
3 participants
@davep @willmcgugan @TomJGooding