rustdoc: Fix invalid suggestions on ambiguous intra doc links#108699
Closed
GuillaumeGomez wants to merge 2 commits intorust-lang:masterfrom
Closed
rustdoc: Fix invalid suggestions on ambiguous intra doc links#108699GuillaumeGomez wants to merge 2 commits intorust-lang:masterfrom
GuillaumeGomez wants to merge 2 commits intorust-lang:masterfrom
Conversation
rustbot
added
S-waiting-on-review
GuillaumeGomez
force-pushed
the
fix-invalid-suggestion-ambiguous-intra-doc
branch
from
24483e9 to
1588d7d
Compare
jyn514
reviewed
Mar 3, 2023
GuillaumeGomez
force-pushed
the
fix-invalid-suggestion-ambiguous-intra-doc
branch
from
1588d7d to
a830d71
Compare
Contributor
|
This doesn't seem correct. Try running the below test case: // This is ensuring that the UI output for associated items works when it's being documented
// from another item.
#![deny(rustdoc::broken_intra_doc_links)]
#![allow(nonstandard_style)]
pub trait Trait {
type Trait;
const Trait: usize;
}
/// [`Trait`]
//~^ ERROR
/// [`Trait::Trait`]
//~^ ERROR
pub const Trait: usize = 0;Details |
notriddle
requested changes
Mar 3, 2023
Contributor
notriddle
left a comment
notriddle
left a comment
There was a problem hiding this comment.
Add above test case to test suite, and fix buggy check for item kind.
GuillaumeGomez
force-pushed
the
fix-invalid-suggestion-ambiguous-intra-doc
branch
from
a830d71 to
8247b93
Compare
Member
Author
|
I was relying too much on the item on which the intra-doc link was. Big mistake. So instead, I now directly look at the I also added your test, thanks for it! |
Contributor
|
Still falls over, this time in a case that was constructed to not actually have duplicates (so scanning for duplicates does the wrong thing). #![deny(rustdoc::broken_intra_doc_links)]
#![allow(nonstandard_style)]
pub trait Trait {
type Trait;
}
/// [`Struct::Trait`]
//~^ ERROR
pub struct Struct;
impl Trait for Struct {
type Trait = Struct;
}
impl Struct {
pub const Trait: usize = 0;
}error: `Struct::Trait` is and an associated constant |
GuillaumeGomez
force-pushed
the
fix-invalid-suggestion-ambiguous-intra-doc
branch
from
8247b93 to
ff4352e
Compare
Member
Author
|
The problem was that I was stopping the "discovery" when I found one or more match in one location, preventing us to go through all of them. I removed this limitation, fixing this bug and added a new test. |
Contributor
|
There's also a few corner cases involving primitives: #![deny(rustdoc::broken_intra_doc_links)]
#![allow(nonstandard_style)]
/// [`u32::MAX`]
//~^ ERROR
pub mod u32 {
pub trait MAX {}
}Details#![deny(rustdoc::broken_intra_doc_links)]
#![allow(nonstandard_style)]
/// [`u32::MAX`]
//~^ ERROR
pub mod u32 {
pub use std::primitive::u32 as MAX;
}Details#![deny(rustdoc::broken_intra_doc_links)]
#![allow(nonstandard_style)]
pub trait Trait {
type MAX;
}
/// [`u32::MAX`]
//~^ ERROR
impl Trait for u32 {
type MAX = u32;
}Details#![deny(rustdoc::broken_intra_doc_links)]
#![allow(nonstandard_style)]
/// [`u32::MAX`]
//~^ ERROR
pub trait T {
type MAX;
}
impl T for u32 {
type MAX = ();
}Details |
Member
|
Why is this rewriting so much of the resolution code? Don't we already do the majority of this work elsewhere in the pass? |
Member
Author
We could indeed store directly the information we get from the |
notriddle
added
S-waiting-on-author
Member
Author
|
I'll close this one in favour of #109104. |
This file contains hidden or 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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
4 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Fixes #108653.
r? @notriddle