about summary refs log tree commit diff
diff options
context:
space:
mode:
authorBrian Anderson <banderson@mozilla.com>2012-09-28 16:36:01 -0700
committerBrian Anderson <banderson@mozilla.com>2012-09-28 16:36:11 -0700
commit4e2899ba883c706c3ac9e3bd2fe01f8125bf28cf (patch)
treea6814cb442041d2cf4788585c9e11b84e8911209
parent9b64d71848c2121e7ceac00de24a624d63c2dad4 (diff)
docs: Note that the manual is out of date
-rw-r--r--doc/rust.md19
1 files changed, 11 insertions, 8 deletions
diff --git a/doc/rust.md b/doc/rust.md
index 51150bb09d3..a464c101f0e 100644
--- a/doc/rust.md
+++ b/doc/rust.md
@@ -42,14 +42,17 @@ If you have suggestions to make, please try to focus them on *reductions* to
 the language: possible features that can be combined or omitted. We aim to
 keep the size and complexity of the language under control.
 
-**Note on grammar:** The grammar for Rust given in this document is rough and
-very incomplete; only a modest number of sections have accompanying grammar
-rules. Formalizing the grammar accepted by the Rust parser is ongoing work,
-but future versions of this document will contain a complete
-grammar. Moreover, we hope that this grammar will be extracted and verified
-as LL(1) by an automated grammar-analysis tool, and further tested against the
-Rust sources. Preliminary versions of this automation exist, but are not yet
-complete.
+> **Note:** This manual is very out of date. The best source of Rust
+> documentation is currently the tutorial.
+
+> **Note:** The grammar for Rust given in this document is rough and
+> very incomplete; only a modest number of sections have accompanying grammar
+> rules. Formalizing the grammar accepted by the Rust parser is ongoing work,
+> but future versions of this document will contain a complete
+> grammar. Moreover, we hope that this grammar will be extracted and verified
+> as LL(1) by an automated grammar-analysis tool, and further tested against the
+> Rust sources. Preliminary versions of this automation exist, but are not yet
+> complete.
 
 # Notation