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

Document test minimality

Browse source
This commit is contained in:
Aleksey Kladov 2020-06-26 18:41:11 +02:00
parent 89277e7a42
commit a1c327ec1c
1 changed files with 11 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

11
docs/dev/README.md
View file

@ -166,6 +166,17 @@ That said, adding an innocent-looking `pub use` is a very simple way to break en
Note: if you enjoyed this abstract hand-waving about boundaries, you might appreciate Note: if you enjoyed this abstract hand-waving about boundaries, you might appreciate
https://www.tedinski.com/2018/02/06/system-boundaries.html https://www.tedinski.com/2018/02/06/system-boundaries.html
## Minimal Tests
Most tests in rust-analyzer start with a snippet of Rust code.
This snippets should be minimal -- if you copy-paste a snippet of real code into the tests, make sure to remove everything which could be removed.
There are many benefits to this:
* less to read or to scroll past
* easier to understand what exactly is tested
* less stuff printed during printf-debugging
* less time to run test
## Order of Imports ## Order of Imports
We separate import groups with blank lines We separate import groups with blank lines