about summary refs log tree commit diff
diff options
context:
space:
mode:
authorBrian Anderson <banderson@mozilla.com>2014-04-14 20:49:29 -0700
committerBrian Anderson <banderson@mozilla.com>2014-04-14 20:49:29 -0700
commitd1eb0e393fb252edd8daa4977c07f30b7f203742 (patch)
tree68c0b07e83522cddc0d1e6dfd62ad20632d7b6f1
parent6bacbcc32efee19f05da01fc9a9474657988485d (diff)
downloadrust-d1eb0e393fb252edd8daa4977c07f30b7f203742.tar.gz
rust-d1eb0e393fb252edd8daa4977c07f30b7f203742.zip
doc: Address feedback about intro
-rw-r--r--src/doc/index.md2
-rw-r--r--src/doc/intro.md3
2 files changed, 4 insertions, 1 deletions
diff --git a/src/doc/index.md b/src/doc/index.md
index 4f01f7f0e04..57d75d7fc46 100644
--- 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
index be5422f41eb..897ded9c2a8 100644
--- 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`.