Merge commit 'b52fb5234cd7c11ecfae51897a6f7fa52e8777fc' into clippyup

1 files changed, 29 insertions, 0 deletions

diff --git a/src/docs/index_refutable_slice.txt b/src/docs/index_refutable_slice.txt
new file mode 100644
index 00000000000..8a7d52761af
--- /dev/null
+++ b/src/docs/index_refutable_slice.txt
@@ -0,0 +1,29 @@
+### What it does
+The lint checks for slice bindings in patterns that are only used to
+access individual slice values.
+
+### Why is this bad?
+Accessing slice values using indices can lead to panics. Using refutable
+patterns can avoid these. Binding to individual values also improves the
+readability as they can be named.
+
+### Limitations
+This lint currently only checks for immutable access inside `if let`
+patterns.
+
+### Example
+```
+let slice: Option<&[u32]> = Some(&[1, 2, 3]);
+
+if let Some(slice) = slice {
+    println!("{}", slice[0]);
+}
+```
+Use instead:
+```
+let slice: Option<&[u32]> = Some(&[1, 2, 3]);
+
+if let Some(&[first, ..]) = slice {
+    println!("{}", first);
+}
+```
\ No newline at end of file