about summary refs log tree commit diff
path: root/src/docs/useless_vec.txt
diff options
context:
space:
mode:
Diffstat (limited to 'src/docs/useless_vec.txt')
-rw-r--r--src/docs/useless_vec.txt18
1 files changed, 18 insertions, 0 deletions
diff --git a/src/docs/useless_vec.txt b/src/docs/useless_vec.txt
new file mode 100644
index 00000000000..ee5afc99e4b
--- /dev/null
+++ b/src/docs/useless_vec.txt
@@ -0,0 +1,18 @@
+### What it does
+Checks for usage of `&vec![..]` when using `&[..]` would
+be possible.
+
+### Why is this bad?
+This is less efficient.
+
+### Example
+```
+fn foo(_x: &[u8]) {}
+
+foo(&vec![1, 2]);
+```
+
+Use instead:
+```
+foo(&[1, 2]);
+```
\ No newline at end of file