Mirrors/rust-analyzer
2
0
Fork 0
mirror of https://github.com/rust-lang/rust-analyzer synced 2024-12-26 21:13:37 +00:00
Code Issues Projects Releases Packages Wiki Activity

fix typos and update descriptions

Browse source
This commit is contained in:
davidsemakula 2024-01-05 01:56:06 +03:00
parent f098123122
commit 7c259a0300
1 changed files with 7 additions and 6 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

13
docs/dev/guide.md
View file

@ -74,8 +74,8 @@ to study its methods to understand all the input data.
[`Change`]: https://github.com/rust-lang/rust-analyzer/blob/2024-01-01/crates/hir-expand/src/change.rs#L10-L42 [`Change`]: https://github.com/rust-lang/rust-analyzer/blob/2024-01-01/crates/hir-expand/src/change.rs#L10-L42
[`FileChange`]: https://github.com/rust-lang/rust-analyzer/blob/2024-01-01/crates/base-db/src/change.rs#L14-L78 [`FileChange`]: https://github.com/rust-lang/rust-analyzer/blob/2024-01-01/crates/base-db/src/change.rs#L14-L78
The `change_file` methods controls the set of the input files, where each file The `change_file` method controls the set of the input files, where each file
has an integer id (`FileId`, picked by the client), text (`Option<Arc<str>>`). has an integer id (`FileId`, picked by the client) and text (`Option<Arc<str>>`).
Paths are tricky; they'll be explained below, in source roots section, Paths are tricky; they'll be explained below, in source roots section,
together with the `set_roots` method. The "source root" [`is_library`] flag together with the `set_roots` method. The "source root" [`is_library`] flag
along with the concept of [`durability`] allows us to add a group of files which along with the concept of [`durability`] allows us to add a group of files which
@ -397,7 +397,7 @@ the `foo` function of the `bar` `impl` in the `baz` module").
[`Intern` and `Lookup`] traits allows us to combine the benefits of positional and numeric [`Intern` and `Lookup`] traits allows us to combine the benefits of positional and numeric
IDs. Implementing both traits effectively creates a bidirectional append-only map IDs. Implementing both traits effectively creates a bidirectional append-only map
between locations and integer IDs (typically newtype wrappers of [`salsa::InternId`]) between locations and integer IDs (typically newtype wrappers for [`salsa::InternId`])
which can "intern" a location and return an integer ID back. The salsa database we use which can "intern" a location and return an integer ID back. The salsa database we use
includes a couple of [interners]. How to "garbage collect" unused locations includes a couple of [interners]. How to "garbage collect" unused locations
is an open question. is an open question.
@ -552,9 +552,10 @@ completion] and serialize results into the LSP.
The [completion implementation] is finally the place where we start doing the actual The [completion implementation] is finally the place where we start doing the actual
work. The first step is to collect the [`CompletionContext`] -- a struct which work. The first step is to collect the [`CompletionContext`] -- a struct which
describes the cursor position in terms of Rust syntax and semantics. For describes the cursor position in terms of Rust syntax and semantics. For
example, `function_syntax: Option<&'a ast::FnDef>` stores a reference to example, `expected_name: Option<NameOrNameRef>` is the syntactic representation
the enclosing function *syntax*, while `function: Option<hir::Function>` is the for the expected name of what we're completing (usually the parameter name of
`Def` for this function. a function argument), while `expected_type: Option<Type>` is the semantic model
for the expected type of what we're completing.
To construct the context, we first do an ["IntelliJ Trick"]: we insert a dummy To construct the context, we first do an ["IntelliJ Trick"]: we insert a dummy
identifier at the cursor's position and parse this modified file, to get a identifier at the cursor's position and parse this modified file, to get a