diff options
| author | bors[bot] <26634292+bors[bot]@users.noreply.github.com> | 2020-08-12 15:15:00 +0000 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2020-08-12 15:15:00 +0000 |
| commit | 3d6889cba72a9d02199f7adaa2ecc69bc30af834 (patch) | |
| tree | a17351b1e3addea0a719f38990fea9289b6ef65e /docs/dev | |
| parent | a573e088ac64eeeb19e4fc74be2ff019be510477 (diff) | |
| parent | 50a02eb3593591a02677e1b56f24d7ff0459b9d0 (diff) | |
| download | rust-3d6889cba72a9d02199f7adaa2ecc69bc30af834.tar.gz rust-3d6889cba72a9d02199f7adaa2ecc69bc30af834.zip | |
Merge #5727
5727: Rename ra_parser -> parser r=matklad a=matklad bors r+ 🤖 Co-authored-by: Aleksey Kladov <aleksey.kladov@gmail.com>
Diffstat (limited to 'docs/dev')
| -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 51cf716b3df..33829c59371 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. ## Parser Tests -Tests for the parser (`ra_parser`) live in the `ra_syntax` crate (see `test_data` directory). +Tests for the parser (`parser`) live in the `ra_syntax` crate (see `test_data` directory). There are two kinds of tests: * Manually written test cases in `parser/ok` and `parser/err` -* "Inline" tests in `parser/inline` (these are generated) from comments in `ra_parser` crate. +* "Inline" tests in `parser/inline` (these are generated) from comments in `parser` crate. 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. 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 d0c6eea61f8..21373729c71 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 ## Code Walk-Through -### `crates/ra_syntax`, `crates/ra_parser` +### `crates/ra_syntax`, `crates/parser` Rust syntax tree structure and parser. See [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 f1bcdc4aff8..c08062ef4dc 100644 --- a/docs/dev/syntax.md +++ b/docs/dev/syntax.md @@ -11,7 +11,7 @@ The things described are implemented in two places * [rowan](https://github.com/rust-analyzer/rowan/tree/v0.9.0) -- a generic library for rowan syntax trees. * [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. Nothing in rust-analyzer except this crate knows about `rowan`. -* [ra_parser](https://github.com/rust-analyzer/rust-analyzer/tree/cf5bdf464cad7ceb9a67e07985a3f4d3799ec0b6/crates/ra_parser) crate parses input tokens into an `ra_syntax` tree +* [parser](https://github.com/rust-analyzer/rust-analyzer/tree/cf5bdf464cad7ceb9a67e07985a3f4d3799ec0b6/crates/parser) crate parses input tokens into an `ra_syntax` tree ## Design Goals |