@@ -9,6 +9,18 @@ provides three kinds of material:
9
9
- Appendix chapters providing rationale and references to languages that
10
10
influenced the design.
11
11
12
+ You may also be interested in the [ grammar] .
13
+
14
+ <div class =" warning " >
15
+
16
+ Warning: This document is incomplete. Documenting everything takes a
17
+ while. We have a [ big issue] to track documentation for every Rust feature,
18
+ so check that out if you can't find something here.
19
+
20
+ </div >
21
+
22
+ ## What * The Reference* is Not
23
+
12
24
This document does not serve as an introduction to the language. Background
13
25
familiarity with the language is assumed. A separate [ book] is available to
14
26
help acquire such background familiarity.
@@ -32,13 +44,17 @@ specific to `rustc` itself, and should not be taken as a specification for
32
44
the Rust language. We intend to produce such a document someday, and until then,
33
45
the reference is the closest thing we have to one.
34
46
47
+ ## How to Read The Reference
48
+
35
49
You sould not read this document sequentially. As a reference document, you
36
50
should skim the table of contents until you find the section you are interested
37
51
in and read that section. If you are viewing this in a browser and have
38
52
JavaScript enabled, you can also press ` s ` or click the magnifying glass on the
39
53
top bar to open a search bar.
40
54
41
- You may also be interested in the [ grammar] .
55
+ ## Contributing
56
+
57
+ We welcome contributions of all kind.
42
58
43
59
You can contribute to this document by opening an issue or sending a pull
44
60
request to [ the Rust Reference repository] . If this document does not answer
@@ -47,14 +63,6 @@ hesitate to file an issue or ask about it in the Rust docs channels on IRC or
47
63
discord. Knowing what people use this document for the most helps direct our
48
64
attention to making those sections the best that they can be.
49
65
50
- <div class =" warning " >
51
-
52
- Warning: This document may be incomplete. Documenting everything takes a
53
- while. We have a [ big issue] to track documentation for every Rust feature,
54
- so check that out if you can't find something here.
55
-
56
- </div >
57
-
58
66
[ book ] : ../book/index.html
59
67
[ standard library ] : ../std/index.html
60
68
[ grammar ] : ../grammar.html
0 commit comments