From 9c7bc106b5170927daddb9a67980b33f36ba5df5 Mon Sep 17 00:00:00 2001 From: mariatta Date: Wed, 9 Oct 2024 17:14:21 -0700 Subject: [PATCH] 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. --- peps/pep-0001.rst | 16 +++++++++++----- 1 file changed, 11 insertions(+), 5 deletions(-) diff --git a/peps/pep-0001.rst b/peps/pep-0001.rst index 28c33f8d9af..679a9390d88 100644 --- a/peps/pep-0001.rst +++ b/peps/pep-0001.rst @@ -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