Skip to content

Commit 9c6cde9

Browse files
warsawhugovk
andauthored
Update peps/pep-0001.rst
Co-authored-by: Hugo van Kemenade <1324225+hugovk@users.noreply.github.com>
1 parent cbbcfbe commit 9c6cde9

File tree

1 file changed

+10
-7
lines changed

1 file changed

+10
-7
lines changed

peps/pep-0001.rst

Lines changed: 10 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -581,13 +581,16 @@ Each PEP should have the following parts/sections:
581581
13. Footnotes -- A collection of footnotes cited in the PEP, and
582582
a place to list non-inline hyperlink targets.
583583

584-
14. Change History -- A summary of major changes the PEP has undergone, based on discussions and feedback.
585-
Think of this as a "changelog" or "release notes" for the PEP. In general, whenever you update the
586-
``Post-History`` header for major changes, add a new bullet item in newest-first (i.e. reverse
587-
chronological) order, using the same ``DD-MMM-YYYY`` format, with sub-bullets summarizing the changes.
588-
You can consider linking this to the same link as the ``Post-History`` link. This isn't mandatory, so
589-
it's left to the PEP author's discretion, but such a section can be helpful for those following along to
590-
understand the evolution of your PEP. Here is :pep:`an example <694#change-history>`.
584+
Change History -- A summary of major changes the PEP has undergone, based on
585+
discussions and feedback. Think of this as a "changelog" or "release notes"
586+
for the PEP. In general, whenever you update the ``Post-History`` header
587+
for major changes, add a new bullet item in newest-first (i.e. reverse
588+
chronological) order, using the same ``DD-MMM-YYYY`` format, with
589+
sub-bullets summarizing the changes. You can consider linking this to the
590+
same link as the ``Post-History`` link. This isn't mandatory, so it's left
591+
to the PEP author's discretion, but such a section can be helpful for those
592+
following along to understand the evolution of your PEP. Here is :pep:`an
593+
example <694#change-history>`.
591594

592595
15. Copyright/license -- Each new PEP must be placed under a dual license of
593596
public domain and CC0-1.0-Universal_ (see this PEP for an example).

0 commit comments

Comments
 (0)