diff options
author | bors[bot] <26634292+bors[bot]@users.noreply.github.com> | 2021-01-18 23:19:53 +0000 |
---|---|---|
committer | GitHub <[email protected]> | 2021-01-18 23:19:53 +0000 |
commit | 5231f4b27098d3eee621d2b781a92c6f3e9f267b (patch) | |
tree | dc40df33717ca3115017a9ecae2347020c253fcd /crates/base_db/src | |
parent | bf889bcf3be44720ca1c26fccec0374dfc7f3763 (diff) | |
parent | e7d1f30cb3c8486a8f00407b314688b7461de9fa (diff) |
Merge #7341
7341: Fix warnings when running `cargo doc --document-private-items` r=Veykril a=jyn514
These were the warnings previously:
<details>
```
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
```
</details>
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.
Co-authored-by: Joshua Nelson <[email protected]>
Diffstat (limited to 'crates/base_db/src')
-rw-r--r-- | crates/base_db/src/input.rs | 2 |
1 files changed, 1 insertions, 1 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 |