diff options
Diffstat (limited to 'docs/dev')
-rw-r--r-- | docs/dev/README.md | 2 | ||||
-rw-r--r-- | docs/dev/style.md | 1 |
2 files changed, 2 insertions, 1 deletions
diff --git a/docs/dev/README.md b/docs/dev/README.md index ca324493f..2795f6b5c 100644 --- a/docs/dev/README.md +++ b/docs/dev/README.md | |||
@@ -170,7 +170,7 @@ In general, API is centered around UI concerns -- the result of the call is what | |||
170 | The results are 100% Rust specific though. | 170 | The results are 100% Rust specific though. |
171 | Shout outs to LSP developers for popularizing the idea that "UI" is a good place to draw a boundary at. | 171 | Shout outs to LSP developers for popularizing the idea that "UI" is a good place to draw a boundary at. |
172 | 172 | ||
173 | ## LSP is sateless | 173 | ## LSP is stateless |
174 | 174 | ||
175 | The protocol is implemented in the mostly stateless way. | 175 | The protocol is implemented in the mostly stateless way. |
176 | A good mental model is HTTP, which doesn't store per-client state, and instead relies on devices like cookies to maintain an illusion of state. | 176 | A good mental model is HTTP, which doesn't store per-client state, and instead relies on devices like cookies to maintain an illusion of state. |
diff --git a/docs/dev/style.md b/docs/dev/style.md index 1a952197f..c8d943142 100644 --- a/docs/dev/style.md +++ b/docs/dev/style.md | |||
@@ -514,6 +514,7 @@ impl Parent { | |||
514 | Use boring and long names for local variables ([yay code completion](https://github.com/rust-analyzer/rust-analyzer/pull/4162#discussion_r417130973)). | 514 | Use boring and long names for local variables ([yay code completion](https://github.com/rust-analyzer/rust-analyzer/pull/4162#discussion_r417130973)). |
515 | The default name is a lowercased name of the type: `global_state: GlobalState`. | 515 | The default name is a lowercased name of the type: `global_state: GlobalState`. |
516 | Avoid ad-hoc acronyms and contractions, but use the ones that exist consistently (`db`, `ctx`, `acc`). | 516 | Avoid ad-hoc acronyms and contractions, but use the ones that exist consistently (`db`, `ctx`, `acc`). |
517 | Prefer American spelling (color, behavior). | ||
517 | 518 | ||
518 | Default names: | 519 | Default names: |
519 | 520 | ||