You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Switch to "Guide-level" and "Reference-level" explanations
As proposed by aturon <3
These sections replace the "Detailed design" and "How do we teach this?"
sections, and switch their order.
Instead of describing how we would teach a change as a result of a
proposal, the "Guide-level explanation" section will actually attempt to
teach the reader the feature, in a lightweight way.
The guide-level explanation appears first in order to help RFC writers
keep Rust users in the front of their minds, and in order to help RFC
readers understand how an RFC will affect them sooner in the RFC. This
will hopefully make the RFC process more accessible to people who are
Rust users but not compiler or language design experts.
This is the bulk of the RFC. Explain the design in enough detail for somebody familiar
20
-
with the language to understand, and for somebody familiar with the compiler to implement.
21
-
This should get into specifics and corner-cases, and include examples of how the feature is used.
19
+
Explain the proposal as if it was already included in the language and you were teaching it to another Rust programmer. That generally means:
22
20
23
-
# How We Teach This
24
-
[how-we-teach-this]: #how-we-teach-this
21
+
- Introducing new named concepts.
22
+
- Explaining the feature largely in terms of examples.
23
+
- Explaining how Rust programmers should *think* about the feature, and how it should impact the way they use Rust. It should explain the impact as concretely as possible.
24
+
- If applicable, provide sample error messages, deprecation warnings, or migration guidance.
25
25
26
-
What names and terminology work best for these concepts and why?
27
-
How is this idea best presented—as a continuation of existing Rust patterns, or as a wholly new one?
26
+
For implementation-oriented RFCs (e.g. for compiler internals), this section should focus on how compiler contributors should think about the change, and give examples of its concrete impact. For policy RFCs, this section should provide an example-driven introduction to the policy, and explain its impact in concrete terms.
28
27
29
-
Would the acceptance of this proposal change how Rust is taught to new users at any level?
30
-
How should this feature be introduced and taught to existing Rust users?
0 commit comments