Skip to content

Commit 9c7bc10

Browse files
committed
PEP 1: Update the "How to teach this" section
Instead of the "How to teach this", ask for documentation updates to accompany the new PEP.
1 parent ef593f4 commit 9c7bc10

File tree

1 file changed

+11
-5
lines changed

1 file changed

+11
-5
lines changed

peps/pep-0001.rst

+11-5
Original file line numberDiff line numberDiff line change
@@ -535,15 +535,21 @@ Each PEP should have the following parts/sections:
535535
to the PEP, those concerns should be explicitly written out to make
536536
sure reviewers of the PEP are aware of them.
537537

538-
8. How to Teach This -- For a PEP that adds new functionality or changes
539-
language behavior, it is helpful to include a section on how to
540-
teach users, new and experienced, how to apply the PEP to their
541-
work.
538+
8. Documentation Updates -- For a PEP that adds new functionality or changes
539+
language behavior, it is helpful to include a section on what
540+
documentation will need to be produced to inform users, new and experience
541+
about the PEP.
542542

543-
This section may include key points and recommended documentation
543+
Include key points and recommended documentation
544544
changes that would help users adopt a new feature or migrate their
545545
code to use a language change.
546546

547+
Track down and list out all the docs that need to be updated or created.
548+
549+
While PEP authors can write the documentation themselves, they can
550+
also ask for further guidance on what docs are needed from
551+
the Python Docs Editorial board and the Python Docs WG.
552+
547553
9. Reference Implementation -- The reference implementation must be
548554
completed before any PEP is given status "Final", but it need not
549555
be completed before the PEP is accepted. While there is merit

0 commit comments

Comments
 (0)