nixos/rfcs
1
0
Fork 0
mirror of https://github.com/NixOS/rfcs.git synced 2025-11-08 19:46:12 +01:00
Code Issues Projects Releases Packages Wiki Activity Actions

Make the detailed design terse by separating examples (#60)

Browse source
This commit is contained in:
John Ericson 2019-11-21 07:37:25 -05:00 • committed by Eelco Dolstra
parent 17e6306f41
commit 337b3d7962
1 changed files with 13 additions and 4 deletions
Download patch file Download diff file Expand all files Collapse all files

17
0000-template.md
View file

@ -22,10 +22,19 @@ outcome?
# Detailed design # Detailed design
[design]: #detailed-design [design]: #detailed-design
This is the bulk of the RFC. Explain the design in enough detail for somebody This is the core, normative part of the RFC. Explain the design in enough
familiar with the ecosystem to understand, and implement. This should get detail for somebody familiar with the ecosystem to understand, and implement.
into specifics and corner-cases, and include examples of how the feature is This should get into specifics and corner-cases. Yet, this section should also
used. be terse, avoiding redundancy even at the cost of clarity.
# Examples and Interactions
[examples-and-interactions]: #examples-and-interactions
This section illustrates the detailed design. This section should clarify all
confusion the reader has from the previous sections. It is especially important
to counterbalance the desired terseness of the detailed design; if you feel
your detailed design is rudely short, consider making this section longer
instead.
# Drawbacks # Drawbacks
[drawbacks]: #drawbacks [drawbacks]: #drawbacks