Skip to content

Commit eafe90c

Browse files
authored
Merge pull request #1792 from rust-lang/TC/remove-apologies
Remove apologies about the Reference
2 parents a763960 + aca918d commit eafe90c

File tree

2 files changed

+3
-18
lines changed

2 files changed

+3
-18
lines changed

README.md

-5
Original file line numberDiff line numberDiff line change
@@ -3,11 +3,6 @@
33
This document is the primary reference for the Rust programming
44
language.
55

6-
This document is not normative. It may include details that are specific
7-
to `rustc` itself, and should not be taken as a specification for the
8-
Rust language. We intend to produce such a document someday, but this is
9-
what we have for now.
10-
116
## Dependencies
127

138
- Nightly Rust

src/introduction.md

+3-13
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,9 @@
11
# Introduction
22

33
This book is the primary reference for the Rust programming language.
4-
It provides three kinds of material:
54

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.
8-
- Appendix chapters providing rationale and references to languages that influenced the design.
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.
5+
> [!NOTE]
6+
> For known bugs in and omissions of this book, see our [GitHub issues]. If you see a case where the compiler behavior and the text here do not agree, file an issue so we can think about which is correct.
137
148
## Rust releases
159

@@ -45,10 +39,6 @@ Instead, think of the compiled program as a black box.
4539
You can only probe by running it, feeding it input and observing its output.
4640
Everything that happens that way must conform to what the reference says.
4741

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-
5242
## How to use this book
5343

5444
This book does not assume you are reading this book sequentially.
@@ -127,7 +117,7 @@ We welcome contributions of all kinds.
127117
You can contribute to this book by opening an issue or sending a pull request to [the Rust Reference repository].
128118
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].
129119
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].
120+
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].
131121

132122
[book]: ../book/index.html
133123
[github issues]: https://github.com/rust-lang/reference/issues

0 commit comments

Comments
 (0)