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

APE 1: Number is gone once reserved (naming chaos fix 2) #97

Merged
merged 2 commits into from
Mar 4, 2024

Conversation

pllim
Copy link
Member

@pllim pllim commented Feb 5, 2024

Motivation: Asking people to put a number in APE proposal filename too early and then changing the number last minute can cause merge conflict (for another open APE proposal) and confusion (for everyone else).

Case study:

But why are we renaming? To prevent gaps in accepted APE listing (e.g., the still open #14 and the missing APE 11 in the list of accepted APEs).

But are gaps really a big deal? In PEP (Python), they don't do re-numbering. And maybe neither in NEP (NumPy).

Proposed solution: As long as APE author follows the rules and use the next available number properly, the number is considered taken and cannot be reused. If the proposal is rejected, it either appears as a gap in the README or CoCo can say that APE number was rejected. Exception can be made to re-use a number if the proposal PR is closed as invalid/spam. If APE author uses an invalid number, reviewer would point that out very early in the review process (I think that is already status quo at the time of writing this PR).

Pros: No more numbering confusion.
Cons: Might end up with a lot of gaps in the listing of accepted APEs. For example, people will keep wondering what happened to APE 11 like we do with Windows 9.

Alternative:

More discussion: https://groups.google.com/g/astropy-dev/c/7Tnx7S3aGP4

@pllim pllim marked this pull request as ready for review March 4, 2024 17:26
@pllim
Copy link
Member Author

pllim commented Mar 4, 2024

Lots of support for this one, so taking it out of draft.

@eteq
Copy link
Member

eteq commented Mar 4, 2024

This is clearly the winner, so merging this over #96

@eteq eteq merged commit b80aaf2 into astropy:main Mar 4, 2024
@eteq
Copy link
Member

eteq commented Mar 4, 2024

@ceb8 volunteered to update the readme in this repo to reflect this change. Thanks!

@pllim pllim deleted the ape-proposal-number-fifo branch March 4, 2024 17:29
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants