Skip to content

Conversation

@warsaw
Copy link
Member

@warsaw warsaw commented Feb 1, 2026

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/

Copy link
Contributor

@cdce8p cdce8p left a 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.

* [ ] [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

@warsaw warsaw requested a review from a team as a code owner February 2, 2026 05:47
@warsaw
Copy link
Member Author

warsaw commented Feb 2, 2026

It might also make sense to update the PR template then.

Thanks, great suggestion! I noticed a few other section headers missing so have now added those too (plus a spelling fix).

@warsaw
Copy link
Member Author

warsaw commented Feb 2, 2026

BTW, ChatGPT has some fascinating things to say about the British inconsistency of the word "judgement":

So in Britain:
You pass judgement
A court hands down a judgment

Same country. Same word. Different spellings depending on whether wigs are involved.

@brettcannon
Copy link
Member

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
@warsaw
Copy link
Member Author

warsaw commented Feb 2, 2026

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).

Good idea. Done.

warsaw and others added 2 commits February 2, 2026 13:29
Co-authored-by: Marc Mueller <30130371+cdce8p@users.noreply.github.com>
Co-authored-by: Marc Mueller <30130371+cdce8p@users.noreply.github.com>
warsaw and others added 3 commits February 3, 2026 09:31
Co-authored-by: Hugo van Kemenade <1324225+hugovk@users.noreply.github.com>
Co-authored-by: Hugo van Kemenade <1324225+hugovk@users.noreply.github.com>
Co-authored-by: Hugo van Kemenade <1324225+hugovk@users.noreply.github.com>
@warsaw warsaw enabled auto-merge (squash) February 3, 2026 17:38
@warsaw warsaw merged commit d0dce1d into python:main Feb 3, 2026
5 checks passed
@warsaw warsaw deleted the pep-12-changes branch February 3, 2026 17:41
mgorny pushed a commit to wheelnext/peps that referenced this pull request Feb 10, 2026
* Add a Change History section.
* Add a few missing suggested section headers to the PR template
* Add a Change History to PEP 1
* Update peps/pep-0012/pep-NNNN.rst

Co-authored-by: Marc Mueller <30130371+cdce8p@users.noreply.github.com>

* Update peps/pep-0001.rst

Co-authored-by: Marc Mueller <30130371+cdce8p@users.noreply.github.com>

* Update peps/pep-0012/pep-NNNN.rst

Co-authored-by: Hugo van Kemenade <1324225+hugovk@users.noreply.github.com>

* Update peps/pep-0012.rst

Co-authored-by: Hugo van Kemenade <1324225+hugovk@users.noreply.github.com>

* Update peps/pep-0001.rst

Co-authored-by: Hugo van Kemenade <1324225+hugovk@users.noreply.github.com>

---------

Co-authored-by: Marc Mueller <30130371+cdce8p@users.noreply.github.com>
Co-authored-by: Hugo van Kemenade <1324225+hugovk@users.noreply.github.com>
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.

4 participants