aboutsummaryrefslogtreecommitdiff
path: root/docs/dev
diff options
context:
space:
mode:
Diffstat (limited to 'docs/dev')
-rw-r--r--docs/dev/README.md2
-rw-r--r--docs/dev/style.md1
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
170The results are 100% Rust specific though. 170The results are 100% Rust specific though.
171Shout outs to LSP developers for popularizing the idea that "UI" is a good place to draw a boundary at. 171Shout 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
175The protocol is implemented in the mostly stateless way. 175The protocol is implemented in the mostly stateless way.
176A 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. 176A 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 {
514Use boring and long names for local variables ([yay code completion](https://github.com/rust-analyzer/rust-analyzer/pull/4162#discussion_r417130973)). 514Use boring and long names for local variables ([yay code completion](https://github.com/rust-analyzer/rust-analyzer/pull/4162#discussion_r417130973)).
515The default name is a lowercased name of the type: `global_state: GlobalState`. 515The default name is a lowercased name of the type: `global_state: GlobalState`.
516Avoid ad-hoc acronyms and contractions, but use the ones that exist consistently (`db`, `ctx`, `acc`). 516Avoid ad-hoc acronyms and contractions, but use the ones that exist consistently (`db`, `ctx`, `acc`).
517Prefer American spelling (color, behavior).
517 518
518Default names: 519Default names:
519 520