|
3 | 3 | This book is the primary reference for the Rust programming language. |
4 | 4 | It provides three kinds of material: |
5 | 5 |
|
6 | | - - Chapters that informally describe each language construct and their use. |
7 | | - - Chapters that informally describe the memory model, concurrency model, runtime services, linkage model, and debugging facilities. |
| 6 | + - Chapters that describe each language construct and their use. |
| 7 | + - Chapters that describe the memory model, concurrency model, runtime services, linkage model, and debugging facilities. |
8 | 8 | - Appendix chapters providing rationale and references to languages that influenced the design. |
9 | 9 |
|
10 | | -> [!WARNING] |
11 | | -> This book is incomplete. Documenting everything takes a while. |
12 | | -> See the [GitHub issues] for what is not documented in this book. |
| 10 | +> [!NOTE] |
| 11 | +> For known bugs in and omissions of this book, see our [GitHub issues]. |
13 | 12 |
|
14 | 13 | ## Rust releases |
15 | 14 |
|
@@ -45,10 +44,6 @@ Instead, think of the compiled program as a black box. |
45 | 44 | You can only probe by running it, feeding it input and observing its output. |
46 | 45 | Everything that happens that way must conform to what the reference says. |
47 | 46 |
|
48 | | -Finally, this book is not normative. |
49 | | -It may include details that are specific to `rustc` itself, and should not be taken as a specification for the Rust language. |
50 | | -We intend to produce such a book someday, and until then, the reference is the closest thing we have to one. |
51 | | - |
52 | 47 | ## How to use this book |
53 | 48 |
|
54 | 49 | This book does not assume you are reading this book sequentially. |
@@ -127,7 +122,7 @@ We welcome contributions of all kinds. |
127 | 122 | You can contribute to this book by opening an issue or sending a pull request to [the Rust Reference repository]. |
128 | 123 | If this book does not answer your question, and you think its answer is in scope of it, please do not hesitate to [file an issue] or ask about it in the `t-lang/doc` stream on [Zulip]. |
129 | 124 | Knowing what people use this book for the most helps direct our attention to making those sections the best that they can be. |
130 | | -We also want the reference to be as normative as possible, so if you see anything that is wrong or is non-normative but not specifically called out, please also [file an issue]. |
| 125 | +And of course, if you see anything that is wrong or is non-normative but not specifically called out as such, please also [file an issue]. |
131 | 126 |
|
132 | 127 | [book]: ../book/index.html |
133 | 128 | [github issues]: https://github.com/rust-lang/reference/issues |
|
0 commit comments