Skip to content
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

Remove RGBATuple #3102

Merged
merged 1 commit into from
Sep 16, 2024
Merged

Remove RGBATuple #3102

merged 1 commit into from
Sep 16, 2024

Conversation

Starbuck5
Copy link
Member

My contention is that we don't need a type alias for this, we should show what functions actually return instead of adding an additional level of indirection. It is the documentation's job to say how the returned values should be interpreted, not the type system's.

Previously discussed here: https://github.com/pygame-community/pygame-ce/pull/3076/files/cdf6e919b7aa397122e394c7b38d12c7bb48d002#r1726390905

I don't think we've reached consensus on this yet, but this PR needs to be resolved before 2.5.2 unless RGBATuple will "never" be able to be removed. Normally I'd err on the side of the status quo, but for this issue we can always add it back, but once it is in a full release it will be hard to remove.

My contention is that we don't need a type alias for this, we should show what functions actually return instead of adding an additional level of indirection. It is the documentation's job to say how the returned values should be interpreted, not the type system's.
@Starbuck5 Starbuck5 requested a review from a team as a code owner September 16, 2024 04:40
@Starbuck5 Starbuck5 marked this pull request as draft September 16, 2024 04:41
@Starbuck5 Starbuck5 added the type hints Type hint checking related tasks label Sep 16, 2024
@Starbuck5 Starbuck5 added this to the 2.5.2 milestone Sep 16, 2024
Copy link
Member

@ankith26 ankith26 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I don't feel strongly about it either way. But I think we can go with this PR because as you said, we can always add it later if we see the need.

@Starbuck5 Starbuck5 marked this pull request as ready for review September 16, 2024 05:17
Copy link
Member

@ankith26 ankith26 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM, thanks! 🥳

Copy link
Member

@damusss damusss left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I Agree, LGTM 👍

@damusss damusss merged commit e5f62f5 into pygame-community:main Sep 16, 2024
26 checks passed
@Starbuck5 Starbuck5 deleted the remove-rgbatuple branch September 17, 2024 06:06
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
type hints Type hint checking related tasks
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants