Skip to content

Commit

Permalink
PEP 1: Update the "How to teach this" section
Browse files Browse the repository at this point in the history
Instead of the "How to teach this", ask for
documentation updates to accompany the new PEP.
  • Loading branch information
Mariatta committed Oct 10, 2024
1 parent 4c8e388 commit f162133
Showing 1 changed file with 11 additions and 5 deletions.
16 changes: 11 additions & 5 deletions peps/pep-0001.rst
Original file line number Diff line number Diff line change
Expand Up @@ -535,15 +535,21 @@ Each PEP should have the following parts/sections:
to the PEP, those concerns should be explicitly written out to make
sure reviewers of the PEP are aware of them.

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

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

Track down and list out all the docs that need to be updated or created.

While PEP authors can write the documentation themselves, they can
also ask for further guidance on what docs are needed from
the Python Docs Editorial board and the Python Docs WG.

9. Reference Implementation -- The reference implementation must be
completed before any PEP is given status "Final", but it need not
be completed before the PEP is accepted. While there is merit
Expand Down

0 comments on commit f162133

Please sign in to comment.