diff options
-rw-r--r-- | docs/dev/README.md | 7 |
1 files changed, 7 insertions, 0 deletions
diff --git a/docs/dev/README.md b/docs/dev/README.md index 1ce8666e3..2e4a45998 100644 --- a/docs/dev/README.md +++ b/docs/dev/README.md | |||
@@ -236,6 +236,13 @@ struct Foo { | |||
236 | } | 236 | } |
237 | ``` | 237 | ``` |
238 | 238 | ||
239 | ## Variable Naming | ||
240 | |||
241 | We generally use boring and long names for local variables ([yay code completion](https://github.com/rust-analyzer/rust-analyzer/pull/4162#discussion_r417130973)). | ||
242 | The default name is lowercased named of the type: `global_state: GlobalState`. | ||
243 | Avoid ad-hoc acronyms and contractions, but use the ones that exist consistently (`db`, `ctx`, `acc`). | ||
244 | The default name for "result of the function" local variable is `res`. | ||
245 | |||
239 | ## Preconditions | 246 | ## Preconditions |
240 | 247 | ||
241 | Function preconditions should generally be expressed in types and provided by the caller (rather than checked by callee): | 248 | Function preconditions should generally be expressed in types and provided by the caller (rather than checked by callee): |