Clarify event.custom_type docs
#2527
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
The issue this is meant to address for convenience of reviewers: #1758 |
oddbookworm
reviewed
Oct 24, 2023
docs/reST/ref/event.rst
Outdated
| @@ -455,7 +455,8 @@ On Android, the following events can be generated | |||
| | :sl:`make custom user event type` | |||
| | :sg:`custom_type() -> int` | |||
|
|
|||
| Reserves a ``pygame.USEREVENT`` for a custom use. | |||
| Returns an integer value that represents a reserved ``pygame.USEREVENT`` for a custom use. | |||
There was a problem hiding this comment.
Hmmmmm, this doesn't really seem any clearer IMO. Maybe something alone the lines of
"Reserves an event slot for use in a custom event (pygame.USEREVENT) and returns the integer that the event slot is reserved to"
There was a problem hiding this comment.
I think @oddbookworm solution is easier to understand.
ankith26
reviewed
Oct 26, 2023
MyreMylar
approved these changes
Oct 26, 2023
ankith26
changed the title
event.custom_type docs
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.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
I tried to keep in mind the original suggestion made by @Felix3qH4 and the correction made by @oddbookworm. Hopefully the behaviour of pygame.event.custom_type() is clearer now.