From d1eb0e393fb252edd8daa4977c07f30b7f203742 Mon Sep 17 00:00:00 2001 From: Brian Anderson Date: Mon, 14 Apr 2014 20:49:29 -0700 Subject: [PATCH] doc: Address feedback about intro --- src/doc/index.md | 2 +- src/doc/intro.md | 3 +++ 2 files changed, 4 insertions(+), 1 deletion(-) diff --git a/src/doc/index.md b/src/doc/index.md index 4f01f7f0e04cb..57d75d7fc469e 100644 --- a/src/doc/index.md +++ b/src/doc/index.md @@ -7,7 +7,7 @@ li {list-style-type: none; } -* [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 be5422f41ebc8..897ded9c2a865 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`.