aboutsummaryrefslogtreecommitdiff
path: root/docs/dev/style.md
diff options
context:
space:
mode:
Diffstat (limited to 'docs/dev/style.md')
-rw-r--r--docs/dev/style.md10
1 files changed, 5 insertions, 5 deletions
diff --git a/docs/dev/style.md b/docs/dev/style.md
index 48ce4b92a..468dedff2 100644
--- a/docs/dev/style.md
+++ b/docs/dev/style.md
@@ -53,9 +53,9 @@ https://www.tedinski.com/2018/02/06/system-boundaries.html
53## Crates.io Dependencies 53## Crates.io Dependencies
54 54
55We try to be very conservative with usage of crates.io dependencies. 55We try to be very conservative with usage of crates.io dependencies.
56Don't use small "helper" crates (exception: `itertools` is allowed). 56Don't use small "helper" crates (exception: `itertools` and `either` are allowed).
57If there's some general reusable bit of code you need, consider adding it to the `stdx` crate. 57If there's some general reusable bit of code you need, consider adding it to the `stdx` crate.
58A useful exercise is to read Cargo.lock and see if some of the *transitive* dependencies do not make sense for rust-analyzer. 58A useful exercise is to read Cargo.lock and see if some *transitive* dependencies do not make sense for rust-analyzer.
59 59
60**Rationale:** keep compile times low, create ecosystem pressure for faster compiles, reduce the number of things which might break. 60**Rationale:** keep compile times low, create ecosystem pressure for faster compiles, reduce the number of things which might break.
61 61
@@ -330,7 +330,7 @@ When implementing `do_thing`, it might be very useful to create a context object
330 330
331```rust 331```rust
332pub fn do_thing(arg1: Arg1, arg2: Arg2) -> Res { 332pub fn do_thing(arg1: Arg1, arg2: Arg2) -> Res {
333 let mut ctx = Ctx { arg1, arg2 } 333 let mut ctx = Ctx { arg1, arg2 };
334 ctx.run() 334 ctx.run()
335} 335}
336 336
@@ -586,7 +586,7 @@ use super::{}
586 586
587**Rationale:** consistency. 587**Rationale:** consistency.
588Reading order is important for new contributors. 588Reading order is important for new contributors.
589Grouping by crate allows to spot unwanted dependencies easier. 589Grouping by crate allows spotting unwanted dependencies easier.
590 590
591## Import Style 591## Import Style
592 592
@@ -779,7 +779,7 @@ assert!(x < y);
779assert!(x > 0); 779assert!(x > 0);
780 780
781// BAD 781// BAD
782assert!(x >= lo && x <= hi>); 782assert!(x >= lo && x <= hi);
783assert!(r1 < l2 || l1 > r2); 783assert!(r1 < l2 || l1 > r2);
784assert!(y > x); 784assert!(y > x);
785assert!(0 > x); 785assert!(0 > x);