doc: Address feedback about intro

brson · Apr 15, 2014 · d1eb0e3 · d1eb0e3 · alexcrichton · Apr 15, 2014
1 parent 6bacbcc
commit d1eb0e3
Show file tree

Hide file tree

Showing 2 changed files with 4 additions and 1 deletion.
diff --git a/src/doc/index.md b/src/doc/index.md
@@ -7,7 +7,7 @@
 li {list-style-type: none; }
 </style>
 
-* [A 30-minute Intro to Rust](intro.html) (read this first)
+* [A 30-minute Intro to Rust](intro.html)
 * [The Rust tutorial](tutorial.html)  (* [PDF](tutorial.pdf))
 * [The Rust reference manual](rust.html) (* [PDF](rust.pdf))
 

diff --git a/src/doc/intro.md b/src/doc/intro.md
@@ -36,6 +36,9 @@ int add_one(void)
 }
 ```
 
+**Note: obviously this is very simple and non-idiomatic C++.
+You wouldn't write it in practice; it is for illustrative purposes.**
+
 This function allocates an integer on the stack,
 and stores it in a variable, `i`.
 It then returns a reference to the variable `i`.