language-servers/rust-analyzer
1
0
Fork 0
mirror of https://github.com/rust-lang/rust-analyzer.git synced 2025-11-14 01:41:26 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 2

Fix more docs

Browse source
This commit is contained in:
Ifeanyi Orizu 2025-08-01 00:33:01 -05:00
parent 76b2333c1b
commit dbae9ae357
1 changed files with 8 additions and 6 deletions
Download patch file Download diff file Expand all files Collapse all files

14
docs/book/src/contributing/style.md
View file

@ -49,8 +49,8 @@ In this case, we'll probably ask you to split API changes into a separate PR.
Changes of the third group should be pretty rare, so we don't specify any specific process for them. Changes of the third group should be pretty rare, so we don't specify any specific process for them.
That said, adding an innocent-looking `pub use` is a very simple way to break encapsulation, keep an eye on it! That said, adding an innocent-looking `pub use` is a very simple way to break encapsulation, keep an eye on it!
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 [this post](https://www.tedinski.com/2018/02/06/system-boundaries.html).
https://www.tedinski.com/2018/02/06/system-boundaries.html
## Crates.io Dependencies ## Crates.io Dependencies
@ -231,7 +231,7 @@ fn is_string_literal(s: &str) -> bool {
} }
``` ```
In the "Not as good" version, the precondition that `1` is a valid char boundary is checked in `is_string_literal` and used in `foo`. In the "Bad" version, the precondition that `1` and `s.len() - 1` are valid string literal boundaries is checked in `is_string_literal` but used in `main`.
In the "Good" version, the precondition check and usage are checked in the same block, and then encoded in the types. In the "Good" version, the precondition check and usage are checked in the same block, and then encoded in the types.
**Rationale:** non-local code properties degrade under change. **Rationale:** non-local code properties degrade under change.
@ -271,6 +271,8 @@ fn f() {
} }
``` ```
See also [this post](https://matklad.github.io/2023/11/15/push-ifs-up-and-fors-down.html)
## Assertions ## Assertions
Assert liberally. Assert liberally.
@ -608,7 +610,7 @@ Avoid making a lot of code type parametric, *especially* on the boundaries betwe
```rust ```rust
// GOOD // GOOD
fn frobnicate(f: impl FnMut()) { fn frobnicate(mut f: impl FnMut()) {
frobnicate_impl(&mut f) frobnicate_impl(&mut f)
} }
fn frobnicate_impl(f: &mut dyn FnMut()) { fn frobnicate_impl(f: &mut dyn FnMut()) {
@ -616,7 +618,7 @@ fn frobnicate_impl(f: &mut dyn FnMut()) {
} }
// BAD // BAD
fn frobnicate(f: impl FnMut()) { fn frobnicate(mut f: impl FnMut()) {
// lots of code // lots of code
} }
``` ```
@ -975,7 +977,7 @@ Don't use the `ref` keyword.
**Rationale:** consistency & simplicity. **Rationale:** consistency & simplicity.
`ref` was required before [match ergonomics](https://github.com/rust-lang/rfcs/blob/master/text/2005-match-ergonomics.md). `ref` was required before [match ergonomics](https://github.com/rust-lang/rfcs/blob/master/text/2005-match-ergonomics.md).
Today, it is redundant. Today, it is redundant.
Between `ref` and mach ergonomics, the latter is more ergonomic in most cases, and is simpler (does not require a keyword). Between `ref` and match ergonomics, the latter is more ergonomic in most cases, and is simpler (does not require a keyword).
## Empty Match Arms ## Empty Match Arms