1
1
# Introduction
2
2
3
- This document is the primary reference for the Rust programming language. It
3
+ This book is the primary reference for the Rust programming language. It
4
4
provides three kinds of material:
5
5
6
6
- Chapters that informally describe each language construct and their use.
@@ -13,40 +13,40 @@ provides three kinds of material:
13
13
14
14
<div class =" warning " >
15
15
16
- Warning: This document is incomplete. Documenting everything takes a
16
+ Warning: This book is incomplete. Documenting everything takes a
17
17
while. We have a [ big issue] to track documentation for every Rust feature,
18
18
so check that out if you can't find something here.
19
19
20
20
</div >
21
21
22
22
## What * The Reference* is Not
23
23
24
- This document does not serve as an introduction to the language. Background
24
+ This book does not serve as an introduction to the language. Background
25
25
familiarity with the language is assumed. A separate [ book] is available to
26
26
help acquire such background familiarity.
27
27
28
- This document also does not serve as a reference to the [ standard library]
28
+ This book also does not serve as a reference to the [ standard library]
29
29
included in the language distribution. Those libraries are documented
30
30
separately by extracting documentation attributes from their source code. Many
31
31
of the features that one might expect to be language features are library
32
32
features in Rust, so what you're looking for may be there, not here.
33
33
34
- Similarly, this document does not usually document the specifics of ` rustc ` as a
34
+ Similarly, this book does not usually book the specifics of ` rustc ` as a
35
35
tool or of Cargo. Cargo has a [ book] [ cargo book ] that contains a
36
36
[ reference] [ cargo reference ] . There are a few pages such as [ linkage] that still
37
37
describe how ` rustc ` works.
38
38
39
- This document also only serves as a reference to what is available in stable
39
+ This book also only serves as a reference to what is available in stable
40
40
Rust. For unstable features being worked on, see the [ Unstable Book] .
41
41
42
- Finally, this document is not normative. It may include details that are
42
+ Finally, this book is not normative. It may include details that are
43
43
specific to ` rustc ` itself, and should not be taken as a specification for
44
- the Rust language. We intend to produce such a document someday, and until then,
44
+ the Rust language. We intend to produce such a book someday, and until then,
45
45
the reference is the closest thing we have to one.
46
46
47
47
## How to Use This Book
48
48
49
- This book does not assume you are reading this document sequentially. Each
49
+ This book does not assume you are reading this book sequentially. Each
50
50
chapter generally can be read standalone, but will cross-link to other chapters
51
51
for facets of the language they refer to, but do not discuss.
52
52
@@ -119,11 +119,11 @@ information. These conventions are documented here.
119
119
120
120
We welcome contributions of all kind.
121
121
122
- You can contribute to this document by opening an issue or sending a pull
123
- request to [ the Rust Reference repository] . If this document does not answer
122
+ You can contribute to this book by opening an issue or sending a pull
123
+ request to [ the Rust Reference repository] . If this book does not answer
124
124
your question, and you think its answer is in scope of it, please do not
125
125
hesitate to file an issue or ask about it in the Rust docs channels on IRC or
126
- discord. Knowing what people use this document for the most helps direct our
126
+ discord. Knowing what people use this book for the most helps direct our
127
127
attention to making those sections the best that they can be.
128
128
129
129
[ book ] : ../book/index.html
0 commit comments