]> git.lizzy.rs Git - rust.git/commitdiff
Document test minimality
authorAleksey Kladov <aleksey.kladov@gmail.com>
Fri, 26 Jun 2020 16:41:11 +0000 (18:41 +0200)
committerAleksey Kladov <aleksey.kladov@gmail.com>
Fri, 26 Jun 2020 16:41:11 +0000 (18:41 +0200)
docs/dev/README.md

index 76e1da6cf46f36cba6203899395aa586b3cf7e6d..11dc5261b60dcd976684bcc7b40bd8ae65e5ee42 100644 (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
 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
 
 We separate import groups with blank lines