Enhance pygame.mouse.get_pressed docs
#3084
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
ankith26
reviewed
Aug 28, 2024
Starbuck5
reviewed
Aug 29, 2024
bilhox
approved these changes
Sep 17, 2024
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.
@pgvalle made me notice that the documentation for the function
pygame.mouse.get_pressedcould be improved to say something about the button constants. Since I was enhancing, I also removed some trailing whitespaces, added some quotes around pygame constants and reordered the notions inside the get_pressed function body (I made one note an actual .. note:: and converted 2 notes to description.)I find it to be better, but it is subjective, so let me know.