Skip to content

Commit 21efe9b

Browse files
committed
balance brevity and detail
1 parent 013d355 commit 21efe9b

File tree

1 file changed

+8
-3
lines changed

1 file changed

+8
-3
lines changed

developer-workflow/lang-changes.rst

Lines changed: 8 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -70,9 +70,9 @@ code.
7070
Some things you should **not** do:
7171

7272
- **Don't** format your idea as a Python Enhancement Proposal (*PEP*).
73-
It's good to use the PEP template as a
74-
guide for what information to include, but don't try to write a full PEP
75-
until the idea has been accepted for further consideration.
73+
It's good to use the PEP template as a guide for what information to include,
74+
but don't try to write a full PEP until the idea has been accepted for
75+
further consideration.
7676

7777
- **Don't** create a list of proposed changes. Each idea needs its own
7878
discussion. Proposing a change is significant work. You will need to spend
@@ -102,6 +102,11 @@ Some things you **should** do:
102102
objections that must be answered. Your proposal will be stronger if you can
103103
address these concerns up front.
104104

105+
- Provide enough detail to fully explain your idea, and to show that you have
106+
considered all the implications of the change. Strike the right balance
107+
between brevity and completeness. A shorter proposal will be easier to
108+
discuss, so long as it includes all the necessary information.
109+
105110

106111
Engage in discussion
107112
^^^^^^^^^^^^^^^^^^^^

0 commit comments

Comments
 (0)