From dcb1bd10c23522412ed3e5e623bbce0a6ea057b4 Mon Sep 17 00:00:00 2001 From: Pulkit Goyal <7895pulkit@gmail.com> Date: Sun, 12 May 2019 19:21:03 +0300 Subject: [PATCH] add documentation for the while keyword while keyword is used to define while loops in rust. Fixes #60736. --- src/libstd/keyword_docs.rs | 22 ++++++++++++++++++++++ 1 file changed, 22 insertions(+) diff --git a/src/libstd/keyword_docs.rs b/src/libstd/keyword_docs.rs index ffe50f11e8a50..7686333d7cabb 100644 --- a/src/libstd/keyword_docs.rs +++ b/src/libstd/keyword_docs.rs @@ -558,6 +558,28 @@ mod impl_keyword { } /// [Reference]: ../reference/statements.html#let-statements mod let_keyword { } +#[doc(keyword = "while")] +// +/// while loop +/// +/// `while` is used to define while loops in Rust. It runs the code inside it +/// until the condition in the while loop becomes False or there the code uses +/// `break`. +/// +/// +/// ```rust +/// let mut i = 0; +/// while i > 10 { +/// println!("i is {}", i); +/// i += 1; +/// } +/// ``` +/// +/// For more information on `while` and loops in general, see the [Reference]. +/// +/// [Reference]: ../reference/expressions/loop-expr.html +mod while_keyword { } + #[doc(keyword = "loop")] // /// The loop-defining keyword.