Skip to content

Commit c6f8e61

Browse files
committed
Elaborate the format of the Change History section
* Specify MMM-DD-YYYY bullets * Specify reverse chronological order * Fix a typo and standardize capitalization
1 parent d020123 commit c6f8e61

3 files changed

Lines changed: 11 additions & 8 deletions

File tree

peps/pep-0001.rst

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -583,9 +583,11 @@ Each PEP should have the following parts/sections:
583583

584584
14. Change History -- A summary of major changes the PEP has undergone, based on discussions and feedback.
585585
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, consider adding a dated entry in this section. This isn't
587-
mandatory, so it's left to the PEP author's discretion, but such a section can be helpful for those
588-
following along to understand the evolution of your PEP. Here is :pep:`an example <694#change-history>`.
586+
``Post-History`` header for major changes, add a new bullet item in newest-first (i.e. reverse
587+
chronological) order, using the same ``MMM-DD-YYYY`` format, with sub-bullets summarizing the changes.
588+
This isn't mandatory, so it's left to the PEP author's discretion, but such a section can be helpful for
589+
those following along to understand the evolution of your PEP. Here is :pep:`an example
590+
<694#change-history>`.
589591

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

peps/pep-0012.rst

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -100,8 +100,8 @@ directions below.
100100
feature is described in a Final PEP.
101101

102102
- Change the Created header to today's date. Be sure to follow the
103-
format carefully: it must be in ``dd-mmm-yyyy`` format, where the
104-
``mmm`` is the 3 English letter month abbreviation, i.e. one of Jan,
103+
format carefully: it must be in ``DD-MMM-YYYY`` format, where the
104+
``MMM`` is the 3 English letter month abbreviation, i.e. one of Jan,
105105
Feb, Mar, Apr, May, Jun, Jul, Aug, Sep, Oct, Nov, Dec.
106106

107107
- For Standards Track PEPs, after the Created header, add a
@@ -122,7 +122,7 @@ directions below.
122122
- Post-History can be 'Pending' for now; you'll add dates and corresponding links
123123
to this header each time you post your PEP to the designated discussion forum
124124
(and update the Discussions-To header with said link, as above).
125-
For each thread, use the date (in the ``dd-mmm-yyy`` format) as the
125+
For each thread, use the date (in the ``DD-MMM-YYYY`` format) as the
126126
linked text, and insert the URLs inline as anonymous reST `hyperlinks`_,
127127
with commas in between each posting.
128128

peps/pep-0012/pep-NNNN.rst

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -91,8 +91,9 @@ Footnotes
9191
Change History
9292
==============
9393

94-
[A summary of major changes the PEP has undergone. Add a dated entry here whenever you update the
95-
``Post-History`` header.]
94+
[A summary of major changes the PEP has undergone. Whenever you update the ``Post-History``, add a new bullet
95+
item in newest-first (i.e. reverse chronological) order, using the same ``MMM-DD-YYYY`` format, with
96+
sub-bullets summarizing the changes.]
9697

9798

9899
Copyright

0 commit comments

Comments
 (0)