diff options
Diffstat (limited to 'docs/dev')
-rw-r--r-- | docs/dev/README.md | 2 | ||||
-rw-r--r-- | docs/dev/architecture.md | 3 |
2 files changed, 2 insertions, 3 deletions
diff --git a/docs/dev/README.md b/docs/dev/README.md index f87462400..3af01cd6b 100644 --- a/docs/dev/README.md +++ b/docs/dev/README.md | |||
@@ -314,7 +314,7 @@ We don't have specific rules around git history hygiene. | |||
314 | Maintaining clean git history is encouraged, but not enforced. | 314 | Maintaining clean git history is encouraged, but not enforced. |
315 | We use rebase workflow, it's OK to rewrite history during PR review process. | 315 | We use rebase workflow, it's OK to rewrite history during PR review process. |
316 | 316 | ||
317 | Avoid @mentioning people in commit messages, as such messages create a lot of duplicate notification traffic during rebases. | 317 | Avoid @mentioning people in commit messages and pull request descriptions (they are added to commit message by bors), as such messages create a lot of duplicate notification traffic during rebases. |
318 | 318 | ||
319 | # Architecture Invariants | 319 | # Architecture Invariants |
320 | 320 | ||
diff --git a/docs/dev/architecture.md b/docs/dev/architecture.md index cee916c09..d0c6eea61 100644 --- a/docs/dev/architecture.md +++ b/docs/dev/architecture.md | |||
@@ -170,8 +170,7 @@ The innermost and most elaborate boundary is `hir`. It has a much richer | |||
170 | vocabulary of types than `ide`, but the basic testing setup is the same: we | 170 | vocabulary of types than `ide`, but the basic testing setup is the same: we |
171 | create a database, run some queries, assert result. | 171 | create a database, run some queries, assert result. |
172 | 172 | ||
173 | For comparisons, we use [insta](https://github.com/mitsuhiko/insta/) library for | 173 | For comparisons, we use the `expect` crate for snapshot testing. |
174 | snapshot testing. | ||
175 | 174 | ||
176 | To test various analysis corner cases and avoid forgetting about old tests, we | 175 | To test various analysis corner cases and avoid forgetting about old tests, we |
177 | use so-called marks. See the `marks` module in the `test_utils` crate for more. | 176 | use so-called marks. See the `marks` module in the `test_utils` crate for more. |