Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

PEP 1: Update the "How to teach this" section #4041

Open
wants to merge 3 commits into
base: main
Choose a base branch
from
Open
Changes from 2 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
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 experienced
Mariatta marked this conversation as resolved.
Show resolved Hide resolved
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