Mirrors/rust-analyzer
2
0
Fork 0
mirror of https://github.com/rust-lang/rust-analyzer synced 2025-01-13 13:48:50 +00:00
Code Issues Projects Releases Packages Wiki Activity

Fix typo in style guide

Browse source
This commit is contained in:
Jonas Schievink 2021-04-15 18:38:52 +02:00
parent 4dafc57019
commit 6e575d8c73
1 changed files with 1 additions and 1 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

2
docs/dev/style.md
View file

@ -159,7 +159,7 @@ More than one mark per test / code branch doesn't add significantly to understan
Do not use `#[should_panic]` tests. Do not use `#[should_panic]` tests.
Instead, explicitly check for `None`, `Err`, etc. Instead, explicitly check for `None`, `Err`, etc.
**Rationale:**a `#[should_panic]` is a tool for library authors, to makes sure that API does not fail silently, when misused. **Rationale:** `#[should_panic]` is a tool for library authors, to makes sure that API does not fail silently, when misused.
`rust-analyzer` is not a library, we don't need to test for API misuse, and we have to handle any user input without panics. `rust-analyzer` is not a library, we don't need to test for API misuse, and we have to handle any user input without panics.
Panic messages in the logs from the `#[should_panic]` tests are confusing. Panic messages in the logs from the `#[should_panic]` tests are confusing.