Skip to content

Commit d13e5a1

Browse files
committed
Move "Drawbacks" section after "Detailed design"
Having "Drawbacks" earlier in the document than "Detailed design" makes it awkward to discuss drawbacks that reference details of the design. This encourages authors to either violate causality by referencing details before they are introduced or to neglect the "Drawbacks" section entirely and just sprinkle the discussion of drawbacks throught "Detailed design".
1 parent 562716b commit d13e5a1

File tree

1 file changed

+5
-5
lines changed

1 file changed

+5
-5
lines changed

0000-template.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -10,20 +10,20 @@ One para explanation of the feature.
1010

1111
Why are we doing this? What use cases does it support? What is the expected outcome?
1212

13-
# Drawbacks
14-
15-
Why should we *not* do this?
16-
1713
# Detailed design
1814

1915
This is the bulk of the RFC. Explain the design in enough detail for somebody familiar
2016
with the language to understand, and for somebody familiar with the compiler to implement.
2117
This should get into specifics and corner-cases, and include examples of how the feature is used.
2218

19+
# Drawbacks
20+
21+
Why should we *not* do this?
22+
2323
# Alternatives
2424

2525
What other designs have been considered? What is the impact of not doing this?
2626

2727
# Unresolved questions
2828

29-
What parts of the design are still TBD?
29+
What parts of the design are still TBD?

0 commit comments

Comments
 (0)