search

pygame-community / pygame-ce

🐍🎮 pygame - Community Edition is a FOSS Python library for multimedia applications (like games). Built on top of the excellent SDL library.
https://pyga.me
766 stars 120 forks source link

pygame.Surface docs improvements #2911

Closed REX2626 closed 2 weeks ago

REX2626 commented 3 weeks ago

When reading through the pygame.Surface docs I noticed the following issues/inconsistencies:

  1. One line descriptions of Surface.blits() and Surface.fblits() seemed inconsistent with other descriptions.
  2. Surfaces were sometimes referred to as "images", which didn't make sense to me.
  3. Some of the one line method descriptions started with a capital letter, which was inconsistent with the other descriptions.
  4. Sometimes Surface was captilalized and sometimes it wasn't. I changed these all to capitalized versions.
  5. In the pygame.Surface.convert() description, there was an 'as' when I think there should be an 'a'.

I'm open to any suggestions or thoughts about the changes, whether the Surfaces should be capitalized or not etc..

REX2626 commented 3 weeks ago

Yep, makes sense. I've reverted the surface capitalization back to what is previously was.

Matiiss commented 3 weeks ago

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).