Update docs of Surface.get_(f)rect() and (F)Rect.move_to()
#2901
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
|
Merging this PR in now. PS: we are on a merge freeze for the 2.5.0 release, so when this PR is merged onto main it will get released in the upcoming 2.5.1 release |
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.
As you can see from the changed docs I think I made them clearer. I didn't know you could pass size kwargs myself for a long time. The docs technically didn't hide them, but it's very unclear that they do that. Why?
Yes, they both say that the kwargs should match the attributes and they don't say those are not allowed, but I think this small update makes it more clear.