summaryrefslogtreecommitdiffstats
path: root/src/tools/clippy/src/docs/while_let_on_iterator.txt
diff options
context:
space:
mode:
Diffstat (limited to 'src/tools/clippy/src/docs/while_let_on_iterator.txt')
-rw-r--r--src/tools/clippy/src/docs/while_let_on_iterator.txt20
1 files changed, 20 insertions, 0 deletions
diff --git a/src/tools/clippy/src/docs/while_let_on_iterator.txt b/src/tools/clippy/src/docs/while_let_on_iterator.txt
new file mode 100644
index 000000000..af053c541
--- /dev/null
+++ b/src/tools/clippy/src/docs/while_let_on_iterator.txt
@@ -0,0 +1,20 @@
+### What it does
+Checks for `while let` expressions on iterators.
+
+### Why is this bad?
+Readability. A simple `for` loop is shorter and conveys
+the intent better.
+
+### Example
+```
+while let Some(val) = iter.next() {
+ ..
+}
+```
+
+Use instead:
+```
+for val in &mut iter {
+ ..
+}
+``` \ No newline at end of file