Skip to content
New issue

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

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

Already on GitHub? Sign in to your account

Broken intra-rustdoc-links #1903

Closed
olegnn opened this issue Oct 8, 2019 · 5 comments
Closed

Broken intra-rustdoc-links #1903

olegnn opened this issue Oct 8, 2019 · 5 comments
Labels

Comments

@olegnn
Copy link
Contributor

olegnn commented Oct 8, 2019

I created an issue rust-lang/rust#64193 month ago and there's no progress at all up to 8 october. The problem is that intra-rustdoc-links don't work correctly.

Now these links (for ex.)

don't redirect to correct destination, moreover in some places without context reader can't understand method of which trait/impl/mod is mentioned.

If change them to the full path, we will get warnings (see issue), however links will work. Maybe it's ok for now to have warnings but correctly working links? I could prepare PR with expanded links.

@Nemo157
Copy link
Member

Nemo157 commented Oct 8, 2019

This seems to be somewhat related to rust-lang/rust#60883, the link from futures_channel::mpsc::TrySendError works, but the link from futures::channel::mpsc::TrySendError doesn't.

Applying the suggested change to use an absolute path (mpsc::Sender::try_send) inverts that, the link in the futures docs will start working while the link in futures-channel will stop working (which is why there is a warning emitted). I really don't understand why this is, the absolute path is only valid in futures-channel, so how come it works in the opposite case?

@Nemo157
Copy link
Member

Nemo157 commented Oct 8, 2019

I don't understand why there's no warning emitted currently though. I was scared of rust-lang/rust#58917 causing warnings for cases like this to be suppressed, but that never got merged, so it should be emitting a warning when building the futures docs that it can't resolve the link...

@olegnn
Copy link
Contributor Author

olegnn commented Oct 8, 2019

I didn't pay attention that link from futures_channel::channel::mpsc::TrySendError won't work after changing to absolute path, so then we have 1 correct warning at least.

This's especially strange because after change to futures_channel::mpsc::Receiver::try_next() link from futures::... will work normally, however link from futures_channel::... won't resolve but will generate incorrect url (which is a link with prefix and unresolved path).

@jyn514
Copy link
Member

jyn514 commented Jul 20, 2020

I think this should be fixed now that rust-lang/rust#65983 has been fixed :)

@taiki-e
Copy link
Member

taiki-e commented Sep 5, 2020

Confirmed this has been fixed 🎉

@taiki-e taiki-e closed this as completed Sep 5, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

No branches or pull requests

5 participants