about summary refs log tree commit diff
path: root/src/docs/debug_assert_with_mut_call.txt
diff options
context:
space:
mode:
authorPhilipp Krones <hello@philkrones.com>2022-11-21 19:59:07 +0100
committerPhilipp Krones <hello@philkrones.com>2022-11-21 20:01:17 +0100
commitfd5b85c957d92a3bc5fc754407d1e56aa9178d27 (patch)
treecba25a7cb16b8f5981eb75b1138ece61bb412fb6 /src/docs/debug_assert_with_mut_call.txt
parent80a4699aaeb17903cd55c3159764febf3ff4e7e9 (diff)
parent51ec465cc3dfb62a2dad7e808b399fa76a1c9170 (diff)
Merge remote-tracking branch 'upstream/master' into rustup
Diffstat (limited to 'src/docs/debug_assert_with_mut_call.txt')
-rw-r--r--src/docs/debug_assert_with_mut_call.txt18
1 files changed, 0 insertions, 18 deletions
diff --git a/src/docs/debug_assert_with_mut_call.txt b/src/docs/debug_assert_with_mut_call.txt
deleted file mode 100644
index 2c44abe1f05..00000000000
--- a/src/docs/debug_assert_with_mut_call.txt
+++ /dev/null
@@ -1,18 +0,0 @@
-### What it does
-Checks for function/method calls with a mutable
-parameter in `debug_assert!`, `debug_assert_eq!` and `debug_assert_ne!` macros.
-
-### Why is this bad?
-In release builds `debug_assert!` macros are optimized out by the
-compiler.
-Therefore mutating something in a `debug_assert!` macro results in different behavior
-between a release and debug build.
-
-### Example
-```
-debug_assert_eq!(vec![3].pop(), Some(3));
-
-// or
-
-debug_assert!(takes_a_mut_parameter(&mut x));
-```
\ No newline at end of file