Skip to content

PHEP 1 revision to remove "Accepted" status - #56

Merged
sapols merged 1 commit into
heliophysicsPy:mainfrom
jtniehof:pep1_v2_clarifications
Nov 6, 2026
Merged

sapols merged 1 commit into
heliophysicsPy:mainfrom
jtniehof:pep1_v2_clarifications

Conversation

@jtniehof

@jtniehof jtniehof commented Oct 9, 2026

Copy link
Copy Markdown
Contributor

As noted in this comment, the approved text of PHEP 1 included reference to an "Accepted" status, which was part of PEP 1 but removed in the drafting of PHEP 1.

This revision removes that reference. See the PHEP 1 revision process as a reminder, since this is the first we've done this.

Comment thread pheps/phep-0001.md
8. **How to Teach This** - This section may include key points and recommended documentation changes that would help users, new and experienced, apply the PHEP to their work. This section should also document any changes the PHEP makes relative to a PHEP it replaces or some other widely-used standard or reference. This allows an implementation compliant with a previous PHEP (or other standard) to be easily updated for compliance with the PHEP.

9. **Reference Implementation** - The reference implementation must be completed before any PHEP is given status "Final", but it need not be completed before the PHEP is accepted. While there is merit to the approach of reaching consensus on the specification and rationale before writing code, the principle of "rough consensus and running code" is still useful when it comes to resolving many discussions of API details.
9. **Reference Implementation** - The reference implementation must be completed before any PHEP is accepted and given status "Final", but it need not be completed for the editors to [approve the draft PHEP](#submitting-a-phep) and assign a PHEP number. While there is merit to the approach of reaching consensus on the specification and rationale before writing code, the principle of "rough consensus and running code" is still useful when it comes to resolving many discussions of API details.

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

The smallest possible change would just be to make this sentence 'The reference implementation must be completed before any PHEP is accepted and given status "Final"' without the note on it not being required before number assignment. Open to comment.

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

Arguably I'm violating the spirit of "These changes must be made in a single commit, which the editors can merge after minor discussion. This PR should not be opened until the path forward is clear" by not sorting out which version of wording before opening the PR :)

Comment thread pheps/phep-0001.md
type = {PHEP},
number = {1},
doi = {10.5281/zenodo.10988007}
doi = {10.5281/zenodo.23261633}

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

I have reserved this DOI for the new version

Comment thread pheps/phep-0001.md
number = {1},
doi = {10.5281/zenodo.10988007}
doi = {10.5281/zenodo.23261633}
)

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

It would be nice to have a revision number in the BiBTeX, but that's not an option in the tech report template

@sapols sapols left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Approving! I think the current wording (including the clause about number assignment) is a small enough clarification to fit the revision process, and I’d prefer it over the shorter version.

I’ll fill in the TBD revision date myself right before merging, amending it into your commit to keep the single-commit requirement.

On Zenodo, @jtniehof: did you reserve 10.5281/zenodo.23261633 via “New version” on the existing record (10988007), so it’ll sit under the PHEP 1 concept DOI? And since the draft is presumably in your account, do you want to handle publishing it, or would you rather share access so I can? After merge I’ll tag phep-1-2, render the PDF, and create the GitHub release, so those links will be ready for the Related Works fields.

Also, PHEP 2 has the same sentence. Once this one’s done I’m happy to help with a matching revision PR for it.

@jtniehof

jtniehof commented Nov 4, 2026

Copy link
Copy Markdown
Contributor Author

I’ll fill in the TBD revision date myself right before merging, amending it into your commit to keep the single-commit requirement.

👍

On Zenodo, @jtniehof: did you reserve 10.5281/zenodo.23261633 via “New version” on the existing record (10988007), so it’ll sit under the PHEP 1 concept DOI?

Yes, it's a "new version", and it's on my account, so happy to do the upload once you've done the other release tasks.

Also, PHEP 2 has the same sentence. Once this one’s done I’m happy to help with a matching revision PR for it.

That's a good catch, and deeply irritating. I've drafted an update for 2 and will open up the PR (with date and all that good stuff) once this one is sorted.

…tatus

Amended by the PHEP editor before merge: fill in the revision date, and fix a duplicated "the" in Rejected Ideas.
@sapols
sapols force-pushed the pep1_v2_clarifications branch from 7de6c68 to 71c84b9 Compare November 6, 2026 02:03
@sapols
sapols merged commit e360035 into heliophysicsPy:main Nov 6, 2026
1 check passed
@sapols

sapols commented Nov 6, 2026

Copy link
Copy Markdown
Contributor

@jtniehof Merged and released! PHEP-1 Release 2 is up, so the Zenodo upload is all yours.

Per RELEASE.md:

  • Files: phep-0001.pdf from the release, plus the Markdown source at the tagged commit and the phep-0001/ images
  • Publication date: 05-Nov-2026 · Version: 2 · Dates: Created 20-Oct-2023, Accepted 15-Apr-2024, Updated 05-Nov-2026
  • Related works: "Is derived from" the release URL and the tagged-source URL above; "Is new version of" 10.5281/zenodo.10988007. On the revision 1 record, add "Is previous version of" 10.5281/zenodo.23261633.

FYI, I found a duplicated “the the” under Rejected Ideas we missed and fixed it (recorded in the commit message).

Lastly, the website's PHEP table update is ready in this draft PR; I'll mark it ready and merge it once the DOI is live.

@jtniehof

jtniehof commented Nov 6, 2026

Copy link
Copy Markdown
Contributor Author

Thanks Shawn! https://zenodo.org/records/23261633 is up now, and I updated the v1 record.

@sapols

sapols commented Nov 6, 2026

Copy link
Copy Markdown
Contributor

Thanks Jon! One gap: the v1 record has the phep-0001/ images (process_flow.svg, workflow.dot, workflow.svg), but v2 only has the PDF and Markdown. Could you add them via Edit files → "Edit published files"? Zenodo allows that within 30 days of publishing, and the DOI stays the same. (Tiny nit while you're in there: the Updated date's description says "Revison 2".)

@jtniehof

jtniehof commented Nov 6, 2026

Copy link
Copy Markdown
Contributor Author

Fixed, and fixed. You mentioned the images, too!

@jtniehof
jtniehof deleted the pep1_v2_clarifications branch November 11, 2026 22:48
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