-
-
Notifications
You must be signed in to change notification settings - Fork 158
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.
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
pygame.Surface docs improvements #2911
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I like all the changes, except maybe the surface -> Surface
change. "surface" is not a proper noun, and to my eyes capitalization of it looks weird.
However, I'm not native english speaker so maybe we should wait for other members to put in their opinions on this.
Either way, it would be better if that change was a separate PR, the rest of the changes LGTM
Yep, makes sense. I've reverted the surface capitalization back to what is previously was. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM, thanks for contributing! 🎉
I think we need to decide on the capitalization now, because there are tons of places in this file where it's called a "Surface" and where it's called a "surface", so we can be consistent and lowercase it everywhere (besides type annotations and if they begin a sentence obviously). |
| :sl:`draw many surfaces onto the calling surface at their corresponding location and the same special_flags` | ||
| :sl:`draw many surfaces onto this surface at their corresponding location and with the same special_flags` |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Personally I find "the calling surface" to be clearer than "this surface" because it might not be clear which surface "this" is referring to exactly. This goes for all such occurrences in this file.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
TBH I prefer the current change. To me "calling surface" is not exactly clear, whereas the "this" keyword is used in many programming languages to mean "self"
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM 👍
When reading through the pygame.Surface docs I noticed the following issues/inconsistencies:
I'm open to any suggestions or thoughts about the changes, whether the Surfaces should be capitalized or not etc..