Rollup merge of #26073 - chuckSMASH:trpl-5-4-comments, r=steveklabnik

For a user following the path of reading Chapter 5: Syntax & Symantics
prior to Chapter 4: Learn Rust, this will be the first time they have
encountered executable tests inside documentation comments.

The test will fail because the `add_one` function is not defined in
the context of the doctest. This might not be the optimal place to
introduce and explain the `/// #` notation but I think it is important
that this snippet pass as a test when `rustdoc --test` is run against
it.
This commit is contained in:
Manish Goregaokar 2015-06-09 05:42:27 +05:30
commit 554f595b86

View file

@ -29,6 +29,9 @@ The other kind of comment is a doc comment. Doc comments use `///` instead of
/// let five = 5;
///
/// assert_eq!(6, add_one(5));
/// # fn add_one(x: i32) -> i32 {
/// # x + 1
/// # }
/// ```
fn add_one(x: i32) -> i32 {
x + 1