Skip to content

rustdoc intra links are incorrect for trait provided methods #49582

New issue

Have a question about this project? # for a free GitHub account to open an issue and contact its maintainers and the community.

#

By clicking “#”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? # to your account

Jump to bottom
Closed
crumblingstatue opened this issue Apr 2, 2018 · 1 comment
Closed

rustdoc intra links are incorrect for trait provided methods #49582

crumblingstatue opened this issue Apr 2, 2018 · 1 comment
Assignees
@GuillaumeGomez
Labels
T-rustdoc Relevant to the rustdoc team, which will review and decide on the PR/issue.

Comments

@crumblingstatue
Copy link
Contributor

crumblingstatue commented Apr 2, 2018 •
edited
Loading 

/// Always make sure to implement [`req`], but you don't have to implement [`prov`].
///
/// [`req`]: Foo::req
/// [`prov`]: Foo::prov
pub trait Foo {
	/// Required
	fn req();
	/// Provided
	fn prov() {}
}

req will link to #tymethod.req, which is exists, but prov will also link to #tymethod.prov, which doesn't exist. The correct link is #method.prov.

Ref #43466
@GuillaumeGomez GuillaumeGomez self-assigned this Apr 2, 2018
@GuillaumeGomez GuillaumeGomez added the T-rustdoc Relevant to the rustdoc team, which will review and decide on the PR/issue. label Apr 2, 2018
@GuillaumeGomez
Copy link
Member

Fix done. I'll open the PR in a few hours.

@GuillaumeGomez GuillaumeGomez mentioned this issue Apr 2, 2018
Merged
kennytm added a commit to kennytm/rust that referenced this issue Apr 3, 2018
@kennytm
Rollup merge of rust-lang#49603 - GuillaumeGomez:fix-intra-link-trait…
ec8cde6 
…-provided-method, r=QuietMisdreavus

Fix url for intra link provided method

Fixes rust-lang#49582.

r? @QuietMisdreavus
kennytm added a commit to kennytm/rust that referenced this issue Apr 4, 2018
@kennytm
Rollup merge of rust-lang#49603 - GuillaumeGomez:fix-intra-link-trait…
52fd162 
…-provided-method, r=QuietMisdreavus

Fix url for intra link provided method

Fixes rust-lang#49582.

r? @QuietMisdreavus
# for free to join this conversation on GitHub. Already have an account? # to comment
Assignees

@GuillaumeGomez GuillaumeGomez

Labels
T-rustdoc Relevant to the rustdoc team, which will review and decide on the PR/issue.
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
2 participants
@crumblingstatue @GuillaumeGomez