-
Notifications
You must be signed in to change notification settings - Fork 12.8k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Rollup merge of #120702 - bvanjoi:fix-120444, r=notriddle
docs: also check the inline stmt during redundant link check Fixes #120444 This issue was brought about by querying `root::webdavfs::A`, a key that doesn't exist in `doc_link_resolutions`. To avoid a panic, I've altered the gating mechanism to allow this lint pass to be skipped. I'm not certain if this is the best solution. An alternative approach might be to leverage other info from the name resolutions instead of `doc_link_resolutions`. After all, all we need is to get the resolution from a combination of `(module, name)`. However, I believe they would yield the same outcome, both skipping this lint.
- Loading branch information
Showing
6 changed files
with
111 additions
and
18 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,17 @@ | ||
// compile-flags: --document-private-items | ||
|
||
#![deny(rustdoc::redundant_explicit_links)] | ||
|
||
mod webdavfs { | ||
pub struct A; | ||
pub struct B; | ||
} | ||
|
||
/// [`Vfs`][crate::Vfs] | ||
pub use webdavfs::A; | ||
//~^^ error: redundant explicit link target | ||
|
||
/// [`Vfs`] | ||
pub use webdavfs::B; | ||
|
||
pub struct Vfs; |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,22 @@ | ||
error: redundant explicit link target | ||
--> $DIR/issue-120444-1.rs:10:13 | ||
| | ||
LL | /// [`Vfs`][crate::Vfs] | ||
| ----- ^^^^^^^^^^ explicit target is redundant | ||
| | | ||
| because label contains path that resolves to same destination | ||
| | ||
= note: when a link's destination is not specified, | ||
the label is used to resolve intra-doc links | ||
note: the lint level is defined here | ||
--> $DIR/issue-120444-1.rs:3:9 | ||
| | ||
LL | #![deny(rustdoc::redundant_explicit_links)] | ||
| ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ | ||
help: remove explicit link target | ||
| | ||
LL | /// [`Vfs`] | ||
| ~~~~~~~ | ||
|
||
error: aborting due to 1 previous error | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,17 @@ | ||
// compile-flags: --document-private-items | ||
|
||
#![deny(rustdoc::redundant_explicit_links)] | ||
|
||
pub mod webdavfs { | ||
pub struct A; | ||
pub struct B; | ||
} | ||
|
||
/// [`Vfs`][crate::Vfs] | ||
pub use webdavfs::A; | ||
//~^^ error: redundant explicit link target | ||
|
||
/// [`Vfs`] | ||
pub use webdavfs::B; | ||
|
||
pub struct Vfs; |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,22 @@ | ||
error: redundant explicit link target | ||
--> $DIR/issue-120444-2.rs:10:13 | ||
| | ||
LL | /// [`Vfs`][crate::Vfs] | ||
| ----- ^^^^^^^^^^ explicit target is redundant | ||
| | | ||
| because label contains path that resolves to same destination | ||
| | ||
= note: when a link's destination is not specified, | ||
the label is used to resolve intra-doc links | ||
note: the lint level is defined here | ||
--> $DIR/issue-120444-2.rs:3:9 | ||
| | ||
LL | #![deny(rustdoc::redundant_explicit_links)] | ||
| ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ | ||
help: remove explicit link target | ||
| | ||
LL | /// [`Vfs`] | ||
| ~~~~~~~ | ||
|
||
error: aborting due to 1 previous error | ||
|