-
-
Notifications
You must be signed in to change notification settings - Fork 1.7k
PEP 12 & 1: Add a Change History section #4801
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
base: main
Are you sure you want to change the base?
Conversation
cdce8p
left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
It might also make sense to update the PR template then.
peps/.github/PULL_REQUEST_TEMPLATE/Add a new PEP.md
Lines 30 to 39 in 0d2bacb
| * [ ] [Suggested sections](https://peps.python.org/pep-0012/#suggested-sections) included (unless not applicable) | |
| * [ ] Motivation | |
| * [ ] Rationale | |
| * [ ] Specification | |
| * [ ] Backwards Compatibility | |
| * [ ] Security Implications | |
| * [ ] How to Teach This | |
| * [ ] Reference Implementation | |
| * [ ] Rejected Ideas | |
| * [ ] Open Issues |
Thanks, great suggestion! I noticed a few other section headers missing so have now added those too (plus a spelling fix). |
|
BTW, ChatGPT has some fascinating things to say about the British inconsistency of the word "judgement":
|
|
I would specify the order people should use: chronological or reverse-chronological. Same with a general format (i.e. YYYY-MM-DD for the date). |
* Specify MMM-DD-YYYY bullets * Specify reverse chronological order * Fix a typo and standardize capitalization
Good idea. Done. |
Co-authored-by: Marc Mueller <30130371+cdce8p@users.noreply.github.com>
Co-authored-by: Marc Mueller <30130371+cdce8p@users.noreply.github.com>
For PEP 694, I've found it very helpful to add a Change History section, which makes it easier for readers to understand the evolution of a PEP, especially complex ones. I think it's so useful, I'm proposing we officially add this to the PEP templates, although optionally. PEP authors can decide whether it's helpful or not, but if they do, a standard format is recommended.
📚 Documentation preview 📚: https://pep-previews--4801.org.readthedocs.build/