diff options
Diffstat (limited to 'src/tools/clippy/src/docs/use_debug.txt')
| -rw-r--r-- | src/tools/clippy/src/docs/use_debug.txt | 12 |
1 files changed, 12 insertions, 0 deletions
diff --git a/src/tools/clippy/src/docs/use_debug.txt b/src/tools/clippy/src/docs/use_debug.txt new file mode 100644 index 000000000..94d4a6fd2 --- /dev/null +++ b/src/tools/clippy/src/docs/use_debug.txt @@ -0,0 +1,12 @@ +### What it does +Checks for use of `Debug` formatting. The purpose of this +lint is to catch debugging remnants. + +### Why is this bad? +The purpose of the `Debug` trait is to facilitate +debugging Rust code. It should not be used in user-facing output. + +### Example +``` +println!("{:?}", foo); +```
\ No newline at end of file |