Skip to content

Commit d1eb0e3

Browse files
committed
doc: Address feedback about intro
1 parent 6bacbcc commit d1eb0e3

File tree

2 files changed

+4
-1
lines changed

2 files changed

+4
-1
lines changed

src/doc/index.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@
77
li {list-style-type: none; }
88
</style>
99

10-
* [A 30-minute Intro to Rust](intro.html) (read this first)
10+
* [A 30-minute Intro to Rust](intro.html)
1111
* [The Rust tutorial](tutorial.html) (* [PDF](tutorial.pdf))
1212
* [The Rust reference manual](rust.html) (* [PDF](rust.pdf))
1313

src/doc/intro.md

+3
Original file line numberDiff line numberDiff line change
@@ -36,6 +36,9 @@ int add_one(void)
3636
}
3737
```
3838

39+
**Note: obviously this is very simple and non-idiomatic C++.
40+
You wouldn't write it in practice; it is for illustrative purposes.**
41+
3942
This function allocates an integer on the stack,
4043
and stores it in a variable, `i`.
4144
It then returns a reference to the variable `i`.

0 commit comments

Comments
 (0)