diff options
| author | Guillaume Gomez <guillaume1.gomez@gmail.com> | 2018-08-11 17:02:31 +0200 |
|---|---|---|
| committer | Guillaume Gomez <guillaume1.gomez@gmail.com> | 2018-08-11 20:06:46 +0200 |
| commit | f9f934f7fdf456bd5fcbf96b2123520675c053b7 (patch) | |
| tree | 60ab83ee754dd637fcee31f41f4daa636d2d52a1 | |
| parent | a77dfcc79fe3e7e1a10ae4dccfd4b2e5e0e49195 (diff) | |
| download | rust-f9f934f7fdf456bd5fcbf96b2123520675c053b7.tar.gz rust-f9f934f7fdf456bd5fcbf96b2123520675c053b7.zip | |
Add let keyword doc
| -rw-r--r-- | src/libstd/keyword_docs.rs | 32 |
1 files changed, 31 insertions, 1 deletions
diff --git a/src/libstd/keyword_docs.rs b/src/libstd/keyword_docs.rs index 01bd3edaee9..4f6bda6cfe3 100644 --- a/src/libstd/keyword_docs.rs +++ b/src/libstd/keyword_docs.rs @@ -1,4 +1,4 @@ -// Copyright 2015 The Rust Project Developers. See the COPYRIGHT +// Copyright 2018 The Rust Project Developers. See the COPYRIGHT // file at the top-level directory of this distribution and at // http://rust-lang.org/COPYRIGHT. // @@ -26,3 +26,33 @@ /// /// [book]: https://doc.rust-lang.org/book/second-edition/ch03-03-how-functions-work.html mod fn_keyword { } + +#[doc(keyword = "let")] +// +/// The `let` keyword. +/// +/// The `let` keyword is used to declare a variable. +/// +/// Example: +/// +/// ```rust +/// # #![allow(unused_assignments)] +/// let x = 3; // We create a variable named `x` with the value `3`. +/// ``` +/// +/// By default, all variables are **not** mutable. If you want a mutable variable, +/// you'll have to use the `mut` keyword. +/// +/// Example: +/// +/// ```rust +/// # #![allow(unused_assignments)] +/// let mut x = 3; // We create a mutable variable named `x` with the value `3`. +/// +/// x += 4; // `x` is now equal to `7`. +/// ``` +/// +/// For more information about the `let` keyword, take a look at the [Rust Book][book]. +/// +/// [book]: https://doc.rust-lang.org/book/second-edition/ch03-01-variables-and-mutability.html +mod let_keyword { } |
