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

Moving current scrap API docs to the top to avoid confusion #2515

Merged

Conversation

Matiiss
Copy link
Member

@Matiiss Matiiss commented Oct 12, 2023

There is this notice that "everything below is deprecated" so it sort of made sense to move the working stuff to above that, I don't think that would cause confusion now (but I am not entirely sure what to do with .. ## pygame.scrap ## at the end of the docs, should it just stay at the end anyway? (I don't think we are using that feature anyway)).

Regarding the experimental notice, is that still relevant?

@Matiiss Matiiss requested a review from a team as a code owner October 12, 2023 20:45
Copy link
Member

@MyreMylar MyreMylar left a comment

Choose a reason for hiding this comment

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

LGTM 👍

I mean we could probably actually consider removing the old scrap stuff for 2.4.0 based on the 'two major versions since deprecation' guideline. However, since we've been galloping up major versions quite fast at the minute and this was a fairly large feature set I'd be happy to leave it another version at present. We also haven't officially codified a policy yet on the Wiki.

CPython's policy deprecation-to-removal cycle is two years - which for them also equals two major versions. Numpy uses a 1 year deprecation-to-removal cycle and two major releases (which for them are once every 6 months).

This modules was deprecated 7 months ago in March so there is a little ways to go yet on either rule.

Copy link
Member

@Starbuck5 Starbuck5 left a comment

Choose a reason for hiding this comment

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

Good idea!

@Starbuck5
Copy link
Member

I say keep the experimental notice for now.

I mean we could probably actually consider removing the old scrap stuff for 2.4.0 based on the 'two major versions since deprecation' guideline. However, since we've been galloping up major versions quite fast at the minute and this was a fairly large feature set I'd be happy to leave it another version at present. We also haven't officially codified a policy yet on the Wiki.

We don't have the market share to make large breaking changes. People can switch over to use pygame-ce with no problem because we have made very few backwards-incompatible changes.

@Starbuck5 Starbuck5 merged commit 0076d72 into pygame-community:main Oct 14, 2023
30 checks passed
@Starbuck5 Starbuck5 added docs scrap pygame.scrap labels Oct 14, 2023
@ankith26 ankith26 added this to the 2.4.0 milestone Oct 15, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs scrap pygame.scrap
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

4 participants