Improve color notation in the docs #3165
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
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.
Notation about color values in the docs was messy and scattered. Since
pygame.typing.ColorLikeexists, the docs should point to it to be elegant. (Note: even if 2.5.2 is not out yet, clicking on the data tag will still bring a user to a list of allowed values).color.rst was not changed as it dives deeper on the allowed values, nor gfxdraw.rst since 1) it's not supposed to be used, 2) not all color values are actually supported, but we shouldn't worry about fixing any of this since it's not supposed to be used.
I also modified referring to RGB when it should have actually said Color (pygame.Color) or color (pygame.typing.ColorLike).