diff options
| author | Steve Klabnik <steve@steveklabnik.com> | 2016-11-08 16:20:56 -0500 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2016-11-08 16:20:56 -0500 |
| commit | 8fd202615f3ba5b4ed467c2841c1ebeccff57c48 (patch) | |
| tree | bbe3c9bd06c54d53590dc8e0069ed1aeb40ebb1d /src/doc/reference.md | |
| parent | 38a959a543dfc70a67e64f7d369ed6c9e12fc806 (diff) | |
| parent | daf2d7d63a0fe633dcbc223994849be76e230cae (diff) | |
| download | rust-8fd202615f3ba5b4ed467c2841c1ebeccff57c48.tar.gz rust-8fd202615f3ba5b4ed467c2841c1ebeccff57c48.zip | |
Rollup merge of #35102 - steveklabnik:ref_warning, r=aturon
Make it clear that the reference isn't normative Any time someone edits the reference, it has to be taken very seriously, since it's the closest thing we have to a specification. This commit adds language which indicates that this is not a normative document, which makes it easier to make tweaks without worrying about forever harming the future of Rust by painting ourselves in a corner. r? @aturon
Diffstat (limited to 'src/doc/reference.md')
| -rw-r--r-- | src/doc/reference.md | 5 |
1 files changed, 5 insertions, 0 deletions
diff --git a/src/doc/reference.md b/src/doc/reference.md index 98238e27133..7233dbc618a 100644 --- a/src/doc/reference.md +++ b/src/doc/reference.md @@ -21,6 +21,11 @@ separately by extracting documentation attributes from their source code. Many of the features that one might expect to be language features are library features in Rust, so what you're looking for may be there, not here. +Finally, this document is not normative. It may include details that are +specific to `rustc` itself, and should not be taken as a specification for +the Rust language. We intend to produce such a document someday, but this +is what we have for now. + You may also be interested in the [grammar]. [book]: book/index.html |