diff options
Diffstat (limited to 'docs')
-rw-r--r-- | docs/dev/style.md | 7 | ||||
-rw-r--r-- | docs/user/.gitignore | 1 | ||||
-rw-r--r-- | docs/user/manual.adoc | 9 |
3 files changed, 17 insertions, 0 deletions
diff --git a/docs/dev/style.md b/docs/dev/style.md index 96dd684b3..84485ea28 100644 --- a/docs/dev/style.md +++ b/docs/dev/style.md | |||
@@ -174,6 +174,13 @@ Instead, explicitly check for `None`, `Err`, etc. | |||
174 | `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. | 174 | `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. |
175 | Panic messages in the logs from the `#[should_panic]` tests are confusing. | 175 | Panic messages in the logs from the `#[should_panic]` tests are confusing. |
176 | 176 | ||
177 | ## `#[ignore]` | ||
178 | |||
179 | Do not `#[ignore]` tests. | ||
180 | If the test currently does not work, assert the wrong behavior and add a fixme explaining why it is wrong. | ||
181 | |||
182 | **Rationale:** noticing when the behavior is fixed, making sure that even the wrong behavior is acceptable (ie, not a panic). | ||
183 | |||
177 | ## Function Preconditions | 184 | ## Function Preconditions |
178 | 185 | ||
179 | Express function preconditions in types and force the caller to provide them (rather than checking in callee): | 186 | Express function preconditions in types and force the caller to provide them (rather than checking in callee): |
diff --git a/docs/user/.gitignore b/docs/user/.gitignore new file mode 100644 index 000000000..c32b1bcec --- /dev/null +++ b/docs/user/.gitignore | |||
@@ -0,0 +1 @@ | |||
manual.html | |||
diff --git a/docs/user/manual.adoc b/docs/user/manual.adoc index d5f8dbb1d..816e094c2 100644 --- a/docs/user/manual.adoc +++ b/docs/user/manual.adoc | |||
@@ -201,6 +201,15 @@ $ eselect repository enable guru && emaint sync -r guru | |||
201 | $ emerge rust-analyzer-bin | 201 | $ emerge rust-analyzer-bin |
202 | ---- | 202 | ---- |
203 | 203 | ||
204 | ==== macOS | ||
205 | |||
206 | The `rust-analyzer` binary can be installed via https://brew.sh/[Homebrew]. | ||
207 | |||
208 | [source,bash] | ||
209 | ---- | ||
210 | $ brew install rust-analyzer | ||
211 | ---- | ||
212 | |||
204 | === Emacs | 213 | === Emacs |
205 | 214 | ||
206 | Note this excellent https://robert.kra.hn/posts/2021-02-07_rust-with-emacs/[guide] from https://github.com/rksm[@rksm]. | 215 | Note this excellent https://robert.kra.hn/posts/2021-02-07_rust-with-emacs/[guide] from https://github.com/rksm[@rksm]. |