aboutsummaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorAleksey Kladov <[email protected]>2020-08-18 13:31:50 +0100
committerAleksey Kladov <[email protected]>2020-08-18 13:31:50 +0100
commit0d201638d9c7710795fa24765f7b761432cd5622 (patch)
tree275ea703aeaa5f9bfac22f85eb6e67092196fbfb /docs
parente01cfe2b4508cded9ff9ceda993fa3540de6db83 (diff)
Add default names section
Diffstat (limited to 'docs')
-rw-r--r--docs/dev/style.md9
1 files changed, 7 insertions, 2 deletions
diff --git a/docs/dev/style.md b/docs/dev/style.md
index 8effddcda..2454087e8 100644
--- a/docs/dev/style.md
+++ b/docs/dev/style.md
@@ -148,8 +148,13 @@ struct Foo {
148Use boring and long names for local variables ([yay code completion](https://github.com/rust-analyzer/rust-analyzer/pull/4162#discussion_r417130973)). 148Use boring and long names for local variables ([yay code completion](https://github.com/rust-analyzer/rust-analyzer/pull/4162#discussion_r417130973)).
149The default name is a lowercased name of the type: `global_state: GlobalState`. 149The default name is a lowercased name of the type: `global_state: GlobalState`.
150Avoid ad-hoc acronyms and contractions, but use the ones that exist consistently (`db`, `ctx`, `acc`). 150Avoid ad-hoc acronyms and contractions, but use the ones that exist consistently (`db`, `ctx`, `acc`).
151The default name for "result of the function" local variable is `res`. 151
152The default name for "I don't really care about the name" variable is `it`. 152Default names:
153
154* `res` -- "result of the function" local variable
155* `it` -- I don't really care about the name
156* `n_foo` -- number of foos
157* `foo_idx` -- index of `foo`
153 158
154# Collection types 159# Collection types
155 160