aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
-rw-r--r--docs/dev/style.md16
1 files changed, 16 insertions, 0 deletions
diff --git a/docs/dev/style.md b/docs/dev/style.md
index bb99c4855..397e85b35 100644
--- a/docs/dev/style.md
+++ b/docs/dev/style.md
@@ -112,6 +112,22 @@ Avoid local `use MyEnum::*` imports.
112 112
113Prefer `use crate::foo::bar` to `use super::bar`. 113Prefer `use crate::foo::bar` to `use super::bar`.
114 114
115When implementing `Debug` or `Display`, import `std::fmt`:
116
117```rust
118// Good
119use std::fmt;
120
121impl fmt::Display for RenameError {
122 fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result { .. }
123}
124
125// Not as good
126impl std::fmt::Display for RenameError {
127 fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result { .. }
128}
129```
130
115# Order of Items 131# Order of Items
116 132
117Optimize for the reader who sees the file for the first time, and wants to get a general idea about what's going on. 133Optimize for the reader who sees the file for the first time, and wants to get a general idea about what's going on.