Skip to content

Commit e3663d6

Browse files
authored
Dev docs nits
1 parent 5ed9818 commit e3663d6

File tree

1 file changed

+7
-7
lines changed

1 file changed

+7
-7
lines changed

docs/dev/README.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -55,7 +55,7 @@ You can run `cargo xtask install-pre-commit-hook` to install git-hook to run rus
5555
All Rust code lives in the `crates` top-level directory, and is organized as a
5656
single Cargo workspace. The `editors` top-level directory contains code for
5757
integrating with editors. Currently, it contains the plugin for VS Code (in
58-
typescript). The `docs` top-level directory contains both developer and user
58+
TypeScript). The `docs` top-level directory contains both developer and user
5959
documentation.
6060

6161
We have some automation infra in Rust in the `xtask` package. It contains
@@ -79,8 +79,8 @@ possible. There's **"Run Extension (Debug Build)"** launch configuration for thi
7979
In general, I use one of the following workflows for fixing bugs and
8080
implementing features.
8181

82-
If the problem concerns only internal parts of rust-analyzer (ie, I don't need
83-
to touch `rust-analyzer` crate or typescript code), there is a unit-test for it.
82+
If the problem concerns only internal parts of rust-analyzer (i.e. I don't need
83+
to touch `rust-analyzer` crate or TypeScript code), there is a unit-test for it.
8484
So, I use **Rust Analyzer: Run** action in VS Code to run this single test, and
8585
then just do printf-driven development/debugging. As a sanity check after I'm
8686
done, I use `cargo xtask install --server` and **Reload Window** action in VS
@@ -279,7 +279,7 @@ always obvious from the low-level code.
279279
Syntax trees are by design incomplete and do not enforce well-formedness.
280280
If ast method returns an `Option`, it *can* be `None` at runtime, even if this is forbidden by the grammar.
281281

282-
## LSP indenpendence
282+
## LSP independence
283283

284284
rust-analyzer is independent from LSP.
285285
It provides features for a hypothetical perfect Rust-specific IDE client.
@@ -289,7 +289,7 @@ Internal representations are lowered to LSP in the `rust-analyzer` crate (the on
289289

290290
There's a semi-hard split between "compiler" and "IDE", at the `ra_hir` crate.
291291
Compiler derives new facts about source code.
292-
It explicitly acknowledges that not all info is available (ie, you can't look at types during name resolution).
292+
It explicitly acknowledges that not all info is available (i.e. you can't look at types during name resolution).
293293

294294
IDE assumes that all information is available at all times.
295295

@@ -345,8 +345,8 @@ There's also two VS Code commands which might be of interest:
345345
rust code that it refers to and the rust editor will also highlight the proper
346346
text range.
347347

348-
If you press <kbd>Ctrl</kbd> (i.e. trigger goto definition) in the inspected
349-
Rust source file the syntax tree read-only editor should scroll to and select the
348+
If you trigger Go to Definition in the inspected Rust source file,
349+
the syntax tree read-only editor should scroll to and select the
350350
appropriate syntax node token.
351351

352352
![demo](https://user-images.githubusercontent.com/36276403/78225773-6636a480-74d3-11ea-9d9f-1c9d42da03b0.png)

0 commit comments

Comments
 (0)