about summary refs log tree commit diff
path: root/src/docs/overflow_check_conditional.txt
diff options
context:
space:
mode:
Diffstat (limited to 'src/docs/overflow_check_conditional.txt')
-rw-r--r--src/docs/overflow_check_conditional.txt11
1 files changed, 11 insertions, 0 deletions
diff --git a/src/docs/overflow_check_conditional.txt b/src/docs/overflow_check_conditional.txt
new file mode 100644
index 00000000000..a09cc18a0bc
--- /dev/null
+++ b/src/docs/overflow_check_conditional.txt
@@ -0,0 +1,11 @@
+### What it does
+Detects classic underflow/overflow checks.
+
+### Why is this bad?
+Most classic C underflow/overflow checks will fail in
+Rust. Users can use functions like `overflowing_*` and `wrapping_*` instead.
+
+### Example
+```
+a + b < a;
+```
\ No newline at end of file