diff options
Diffstat (limited to 'docs')
-rw-r--r-- | docs/dev/README.md | 4 | ||||
-rw-r--r-- | docs/dev/architecture.md | 2 | ||||
-rw-r--r-- | docs/dev/syntax.md | 2 |
3 files changed, 4 insertions, 4 deletions
diff --git a/docs/dev/README.md b/docs/dev/README.md index 51cf716b3..33829c593 100644 --- a/docs/dev/README.md +++ b/docs/dev/README.md | |||
@@ -92,11 +92,11 @@ This is primarily useful for performance optimizations, or for bug minimization. | |||
92 | 92 | ||
93 | ## Parser Tests | 93 | ## Parser Tests |
94 | 94 | ||
95 | Tests for the parser (`ra_parser`) live in the `ra_syntax` crate (see `test_data` directory). | 95 | Tests for the parser (`parser`) live in the `ra_syntax` crate (see `test_data` directory). |
96 | There are two kinds of tests: | 96 | There are two kinds of tests: |
97 | 97 | ||
98 | * Manually written test cases in `parser/ok` and `parser/err` | 98 | * Manually written test cases in `parser/ok` and `parser/err` |
99 | * "Inline" tests in `parser/inline` (these are generated) from comments in `ra_parser` crate. | 99 | * "Inline" tests in `parser/inline` (these are generated) from comments in `parser` crate. |
100 | 100 | ||
101 | The purpose of inline tests is not to achieve full coverage by test cases, but to explain to the reader of the code what each particular `if` and `match` is responsible for. | 101 | The purpose of inline tests is not to achieve full coverage by test cases, but to explain to the reader of the code what each particular `if` and `match` is responsible for. |
102 | If you are tempted to add a large inline test, it might be a good idea to leave only the simplest example in place, and move the test to a manual `parser/ok` test. | 102 | If you are tempted to add a large inline test, it might be a good idea to leave only the simplest example in place, and move the test to a manual `parser/ok` test. |
diff --git a/docs/dev/architecture.md b/docs/dev/architecture.md index d0c6eea61..21373729c 100644 --- a/docs/dev/architecture.md +++ b/docs/dev/architecture.md | |||
@@ -64,7 +64,7 @@ The source for 1 and 2 is in [`ast_src.rs`](https://github.com/rust-analyzer/rus | |||
64 | 64 | ||
65 | ## Code Walk-Through | 65 | ## Code Walk-Through |
66 | 66 | ||
67 | ### `crates/ra_syntax`, `crates/ra_parser` | 67 | ### `crates/ra_syntax`, `crates/parser` |
68 | 68 | ||
69 | Rust syntax tree structure and parser. See | 69 | Rust syntax tree structure and parser. See |
70 | [RFC](https://github.com/rust-lang/rfcs/pull/2256) and [./syntax.md](./syntax.md) for some design notes. | 70 | [RFC](https://github.com/rust-lang/rfcs/pull/2256) and [./syntax.md](./syntax.md) for some design notes. |
diff --git a/docs/dev/syntax.md b/docs/dev/syntax.md index f1bcdc4af..c08062ef4 100644 --- a/docs/dev/syntax.md +++ b/docs/dev/syntax.md | |||
@@ -11,7 +11,7 @@ The things described are implemented in two places | |||
11 | * [rowan](https://github.com/rust-analyzer/rowan/tree/v0.9.0) -- a generic library for rowan syntax trees. | 11 | * [rowan](https://github.com/rust-analyzer/rowan/tree/v0.9.0) -- a generic library for rowan syntax trees. |
12 | * [ra_syntax](https://github.com/rust-analyzer/rust-analyzer/tree/cf5bdf464cad7ceb9a67e07985a3f4d3799ec0b6/crates/ra_syntax) crate inside rust-analyzer which wraps `rowan` into rust-analyzer specific API. | 12 | * [ra_syntax](https://github.com/rust-analyzer/rust-analyzer/tree/cf5bdf464cad7ceb9a67e07985a3f4d3799ec0b6/crates/ra_syntax) crate inside rust-analyzer which wraps `rowan` into rust-analyzer specific API. |
13 | Nothing in rust-analyzer except this crate knows about `rowan`. | 13 | Nothing in rust-analyzer except this crate knows about `rowan`. |
14 | * [ra_parser](https://github.com/rust-analyzer/rust-analyzer/tree/cf5bdf464cad7ceb9a67e07985a3f4d3799ec0b6/crates/ra_parser) crate parses input tokens into an `ra_syntax` tree | 14 | * [parser](https://github.com/rust-analyzer/rust-analyzer/tree/cf5bdf464cad7ceb9a67e07985a3f4d3799ec0b6/crates/parser) crate parses input tokens into an `ra_syntax` tree |
15 | 15 | ||
16 | ## Design Goals | 16 | ## Design Goals |
17 | 17 | ||