Wilfred Hughes
deda58e8f1
manual: Convert to mdbook
...
Split manual.adoc into markdown files, one for each chapter.
For the parts of the manual that are generated from source code doc
comments, update the comments to use markdown syntax and update the
code generators to write to `generated.md` files.
For the weekly release, stop copying the .adoc files to the
`rust-analyzer/rust-analyzer.github.io` at release time. Instead,
we'll sync the manual hourly from this repository.
See https://github.com/rust-analyzer/rust-analyzer.github.io/pull/226
for the sync. This PR should be merged first, and that PR needs to be
merged before the next weekly release.
This change is based on #15795 , but rebased and updated. I've also
manually checked each page for markdown syntax issues and fixed any I
encountered.
Co-authored-by: Lukas Wirth <lukastw97@gmail.com>
Co-authored-by: Josh Rotenberg <joshrotenberg@gmail.com>
2025-01-24 13:23:22 -08:00
Young-Flash
ba2910a3a7
minor: correct some typos
2024-02-02 18:22:54 +08:00
Alex Kladov
6303551cb8
internal: use consistent style for error handling
2023-06-19 13:01:47 +01:00
Laurențiu Nicola
d96c489120
Rephrase clippy policy
2022-12-30 16:10:17 +02:00
Jonas Schievink
6c6ae965ba
Update remaining GitHub URLs
2022-07-08 15:44:49 +02:00
Chris Burgess
54f5a68f79
fix typo in style.md
2022-06-11 12:50:36 -04:00
Jonas Schievink
592bc5106c
Update commit/PR style
2022-05-30 15:55:40 +02:00
Marius Ungureanu
b70fa1c717
Fix typo in the style documentation
...
Was going through the documentation itself and found this typo just waiting to be fixed
2022-03-27 15:23:33 +03:00
Waffle Maybe
6ab66d4c9a
minor: fix a typo in the style guide
2022-01-26 17:07:17 +03:00
Aleksey Kladov
d72f7cf3af
internal: add => () rule; emphasize n_items rule
2021-09-25 14:10:25 +03:00
Aleksey Kladov
2d2c4e7c22
internal: deduplicate
2021-09-04 16:56:23 +03:00
Aleksey Kladov
9e0203bd69
internal: make scheduling control flow more obvious
...
There should be only one place where we need to check if we want to
start background activities.
2021-08-30 19:39:08 +03:00
Aleksey Kladov
1660820e51
internal: use idiomatic form of assertions
...
Ideally, we should just return an InvalidParameter dialog here, but that
shows error message to the end user, and we generally avoid that
2021-08-24 14:09:34 +03:00
Aleksey Kladov
629c68e80d
internal: document that ascription is preferred to a turbo fish
2021-08-11 14:16:15 +03:00
Aleksey Kladov
fc48def916
minor: reword a bit
2021-08-10 14:56:55 +03:00
Aleksey Kladov
967c088e01
internal: document codebase stance on using functional combinators
2021-08-10 14:34:05 +03:00
Aleksey Kladov
2f9273633b
feat: filter out duplicate macro completions
...
closes #9303
2021-08-03 17:36:06 +03:00
Aleksey Kladov
12d7f5b56e
internal: explain that we don't ref in style.md
2021-08-02 15:59:28 +03:00
Alexander Gonzalez
c865b56744
docs: Fix several typos and grammar mistakes
2021-07-26 18:15:40 -04:00
Aleksey Kladov
6a0f7f0852
internal: explain why we avoid serializing everything
2021-07-19 17:47:56 +03:00
Aleksey Kladov
a9d0d1414a
internal: remove erroneous default impl
2021-07-12 20:18:07 +03:00
Aleksey Kladov
706bd1c35d
minor: one more usless type
2021-07-08 17:18:44 +03:00
Aleksey Kladov
0db4f3f6a4
internal: ensure consistent passing for config params
...
We pass "context" parametes first, so configs should be on the left.
"Bigger" context wins, so configs goes after db.
2021-07-06 00:00:39 +03:00
Aleksey Kladov
3be9ebe2c3
minor: style
2021-07-04 12:48:29 +03:00
Aleksey Kladov
3f4ad44082
internal: document that we don't #[ignore] tests
2021-06-15 11:46:47 +03:00
Aleksey Kladov
41510f437e
minor: adjust config name
2021-05-17 18:37:06 +03:00
Aleksey Kladov
0650f77dd9
internal: remove one more immutable tree
2021-05-14 16:19:27 +03:00
Aleksey Kladov
ad0648dc95
Cleanup imports
2021-05-13 13:44:47 +03:00
Aleksey Kladov
d4a51241ce
internal: explain why sentence-per-line
2021-05-06 17:40:36 +03:00
Aleksey Kladov
3f6980e4e1
simplify macro expansion code
...
Using `Option` arguments such that you always pass `None` or `Some` at
the call site is a code smell.
2021-05-04 22:41:46 +03:00
Laurențiu Nicola
bb4952da04
internal: Add guidelines for release notes PR descriptions
2021-04-19 21:30:44 +03:00
Jonas Schievink
6e575d8c73
Fix typo in style guide
2021-04-15 18:38:52 +02:00
Aleksey Kladov
db2a989565
internal: don't use #[should_panic] for tests
2021-04-13 12:21:59 +03:00
Kirill Bulatov
b5f3815aee
Small grammar fixes
2021-04-06 21:42:27 +03:00
Aleksey Kladov
a01fd1af19
internal: explain "extract if condition" refactoring
2021-04-05 13:02:47 +03:00
Aleksey Kladov
636c3c49d2
internal: document style for helper functions and variables
2021-04-02 14:52:00 +03:00
Aleksey Kladov
27b779d1fd
internal: document Cargo.lock maintenance process
2021-04-02 13:59:36 +03:00
Aleksey Kladov
30dea3a727
Prefer match to if let else
2021-03-16 10:51:05 +03:00
Laurențiu Nicola
dd9974c59d
Fix cargo xtask lint references
2021-03-14 15:24:34 +02:00
Laurențiu Nicola
fc9eed4836
Use upstream cov-mark
2021-03-08 22:19:44 +02:00
Aleksey Kladov
e15621482c
Clarify comparison rule
2021-03-03 11:23:05 +03:00
azzamsa
ae50b18503
Fix typos
2021-02-20 17:53:19 +07:00
Aleksey Kladov
799810eaaa
Document config pattern
2021-02-12 18:10:16 +03:00
Lukas Wirth
f82ce500a9
Fix spelling mistakes in docs/dev
2021-02-03 13:46:51 +01:00
Aleksey Kladov
283c3b0133
add useless types to the styleguide
2021-02-02 15:41:57 +03:00
Aleksey Kladov
d35bda6429
Make always-assert crate reusable
2021-01-26 22:13:42 +03:00
Laurențiu Nicola
f0cffb66b3
Fix typo in style guide
2021-01-25 14:14:43 +02:00
Aleksey Kladov
e54a398bfb
Promote marks
2021-01-22 17:58:00 +03:00
Aleksey Kladov
4c92ef03ac
Style: use the right string
2021-01-22 15:29:31 +03:00
Aleksey Kladov
74f8201586
Avoid intermediate collections
2021-01-20 14:49:29 +03:00
