]> git.lizzy.rs Git - rust.git/commit
Update doctest in comments.md
authorChuck Bassett <iamchuckb@gmail.com>
Sun, 7 Jun 2015 19:06:58 +0000 (15:06 -0400)
committerChuck Bassett <iamchuckb@gmail.com>
Sun, 7 Jun 2015 19:06:58 +0000 (15:06 -0400)
commit675b3decadc149b400d9afc4c59e0703a0b100ff
tree9ce186f2b06ed144aa8a131dffd9546349d5517d
parentae74652b4a0e0e56a91d9a9dd71ab01e51131dc5
Update doctest in comments.md

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 if it is going to be shown.
src/doc/trpl/comments.md