Merge commit 'b52fb5234cd7c11ecfae51897a6f7fa52e8777fc' into clippyup

1 files changed, 33 insertions, 0 deletions

diff --git a/src/docs/unit_cmp.txt b/src/docs/unit_cmp.txt
new file mode 100644
index 00000000000..6f3d62010dc
--- /dev/null
+++ b/src/docs/unit_cmp.txt
@@ -0,0 +1,33 @@
+### What it does
+Checks for comparisons to unit. This includes all binary
+comparisons (like `==` and `<`) and asserts.
+
+### Why is this bad?
+Unit is always equal to itself, and thus is just a
+clumsily written constant. Mostly this happens when someone accidentally
+adds semicolons at the end of the operands.
+
+### Example
+```
+if {
+    foo();
+} == {
+    bar();
+} {
+    baz();
+}
+```
+is equal to
+```
+{
+    foo();
+    bar();
+    baz();
+}
+```
+
+For asserts:
+```
+assert_eq!({ foo(); }, { bar(); });
+```
+will always succeed
\ No newline at end of file