diff options
author | Joshua Nelson <[email protected]> | 2021-01-18 21:44:40 +0000 |
---|---|---|
committer | Joshua Nelson <[email protected]> | 2021-01-18 21:44:40 +0000 |
commit | e7d1f30cb3c8486a8f00407b314688b7461de9fa (patch) | |
tree | f493a72cf7bdadad95b12f30ecd2de316850d566 /crates | |
parent | 39282ec419046d84ad5972d5b02b1af9885e1282 (diff) |
Fix warnings when running `cargo doc --document-private-items`
These were the warnings previously:
```
warning: could not parse code block as Rust code
--> crates/stdx/src/lib.rs:137:9
|
137 | /// ∀ x in slice[..idx]: pred(x)
| _________^
138 | | /// && ∀ x in slice[idx..]: !pred(x)
| |____^
|
= note: error from rustc: unknown start of token: \u{2200}
warning: 1 warning emitted
warning: unresolved link to `package`
--> crates/base_db/src/input.rs:181:15
|
181 | /// it's [package].name, can be different for other project types or even
| ^^^^^^^ no item named `package` in scope
|
= note: `#[warn(broken_intra_doc_links)]` on by default
= help: to escape `[` and `]` characters, add '\' before them like `\[` or `\]`
warning: unresolved link to `package`
--> crates/base_db/src/input.rs:181:15
|
181 | /// it's [package].name, can be different for other project types or even
| ^^^^^^^ no item named `package` in scope
|
= help: to escape `[` and `]` characters, add '\' before them like `\[` or `\]`
warning: 2 warnings emitted
warning: unresolved link to `package`
--> crates/base_db/src/input.rs:181:15
|
181 | /// it's [package].name, can be different for other project types or even
| ^^^^^^^ no item named `package` in scope
|
= note: `#[warn(broken_intra_doc_links)]` on by default
= help: to escape `[` and `]` characters, add '\' before them like `\[` or `\]`
warning: unresolved link to `package`
--> crates/base_db/src/input.rs:181:15
|
181 | /// it's [package].name, can be different for other project types or even
| ^^^^^^^ no item named `package` in scope
|
= help: to escape `[` and `]` characters, add '\' before them like `\[` or `\]`
warning: 2 warnings emitted
```
This does *not* fix the following warning, because it is actually rust
code and rustdoc is being over eager:
```
warning: Rust code block is empty
--> crates/parser/src/grammar.rs:16:5
|
16 | //! ```
| _____^
17 | | //! // test function_with_zero_parameters
18 | | //! // fn foo() {}
19 | | //! ```
| |_______^
|
help: mark blocks that do not contain Rust code as text
|
16 | //! ```text
| ^^^^^^^
```
https://github.com/rust-lang/rust/pull/79816 should make this
configurable so the warning can be `allow`ed.
Diffstat (limited to 'crates')
-rw-r--r-- | crates/base_db/src/input.rs | 2 | ||||
-rw-r--r-- | crates/parser/src/event.rs | 5 | ||||
-rw-r--r-- | crates/stdx/src/lib.rs | 2 |
3 files changed, 7 insertions, 2 deletions
diff --git a/crates/base_db/src/input.rs b/crates/base_db/src/input.rs index 2dd8fbe67..b5f7e4200 100644 --- a/crates/base_db/src/input.rs +++ b/crates/base_db/src/input.rs | |||
@@ -178,7 +178,7 @@ pub struct CrateData { | |||
178 | pub root_file_id: FileId, | 178 | pub root_file_id: FileId, |
179 | pub edition: Edition, | 179 | pub edition: Edition, |
180 | /// A name used in the package's project declaration: for Cargo projects, | 180 | /// A name used in the package's project declaration: for Cargo projects, |
181 | /// it's [package].name, can be different for other project types or even | 181 | /// its `[package].name` can be different for other project types or even |
182 | /// absent (a dummy crate for the code snippet, for example). | 182 | /// absent (a dummy crate for the code snippet, for example). |
183 | /// | 183 | /// |
184 | /// For purposes of analysis, crates are anonymous (only names in | 184 | /// For purposes of analysis, crates are anonymous (only names in |
diff --git a/crates/parser/src/event.rs b/crates/parser/src/event.rs index a7d06a815..903668892 100644 --- a/crates/parser/src/event.rs +++ b/crates/parser/src/event.rs | |||
@@ -38,14 +38,16 @@ pub(crate) enum Event { | |||
38 | /// | 38 | /// |
39 | /// The events for it would look like this: | 39 | /// The events for it would look like this: |
40 | /// | 40 | /// |
41 | /// | 41 | /// ```text |
42 | /// START(PATH) IDENT('foo') FINISH START(PATH) T![::] IDENT('bar') FINISH | 42 | /// START(PATH) IDENT('foo') FINISH START(PATH) T![::] IDENT('bar') FINISH |
43 | /// | /\ | 43 | /// | /\ |
44 | /// | | | 44 | /// | | |
45 | /// +------forward-parent------+ | 45 | /// +------forward-parent------+ |
46 | /// ``` | ||
46 | /// | 47 | /// |
47 | /// And the tree would look like this | 48 | /// And the tree would look like this |
48 | /// | 49 | /// |
50 | /// ```text | ||
49 | /// +--PATH---------+ | 51 | /// +--PATH---------+ |
50 | /// | | | | 52 | /// | | | |
51 | /// | | | | 53 | /// | | | |
@@ -54,6 +56,7 @@ pub(crate) enum Event { | |||
54 | /// PATH | 56 | /// PATH |
55 | /// | | 57 | /// | |
56 | /// 'foo' | 58 | /// 'foo' |
59 | /// ``` | ||
57 | /// | 60 | /// |
58 | /// See also `CompletedMarker::precede`. | 61 | /// See also `CompletedMarker::precede`. |
59 | Start { | 62 | Start { |
diff --git a/crates/stdx/src/lib.rs b/crates/stdx/src/lib.rs index 1ff2559bb..73b121f8a 100644 --- a/crates/stdx/src/lib.rs +++ b/crates/stdx/src/lib.rs | |||
@@ -134,8 +134,10 @@ impl<'a> Iterator for LinesWithEnds<'a> { | |||
134 | 134 | ||
135 | /// Returns `idx` such that: | 135 | /// Returns `idx` such that: |
136 | /// | 136 | /// |
137 | /// ```text | ||
137 | /// ∀ x in slice[..idx]: pred(x) | 138 | /// ∀ x in slice[..idx]: pred(x) |
138 | /// && ∀ x in slice[idx..]: !pred(x) | 139 | /// && ∀ x in slice[idx..]: !pred(x) |
140 | /// ``` | ||
139 | /// | 141 | /// |
140 | /// https://github.com/rust-lang/rust/issues/73831 | 142 | /// https://github.com/rust-lang/rust/issues/73831 |
141 | pub fn partition_point<T, P>(slice: &[T], mut pred: P) -> usize | 143 | pub fn partition_point<T, P>(slice: &[T], mut pred: P) -> usize |