-
Notifications
You must be signed in to change notification settings - Fork 656
Closed
Labels
Description
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.)
- https://rust-lang-nursery.github.io/futures-api-docs/0.3.0-alpha.19/futures/channel/mpsc/struct.TrySendError.html =>
try_send
, - https://rust-lang-nursery.github.io/futures-api-docs/0.3.0-alpha.19/futures/channel/mpsc/struct.Sender.html =>
channel
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.
Metadata
Metadata
Assignees
Labels
Type
Projects
Milestone
Relationships
Development
Select code repository
Activity
Nemo157 commentedon 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 fromfutures::channel::mpsc::TrySendError
doesn't.Applying the suggested change to use an absolute path (
mpsc::Sender::try_send
) inverts that, the link in thefutures
docs will start working while the link infutures-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 infutures-channel
, so how come it works in the opposite case?Nemo157 commentedon 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 commentedon 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 fromfutures::...
will work normally, however link fromfutures_channel::...
won't resolve but will generate incorrect url (which is a link with prefix and unresolved path).jyn514 commentedon Jul 20, 2020
I think this should be fixed now that rust-lang/rust#65983 has been fixed :)
taiki-e commentedon Sep 5, 2020
Confirmed this has been fixed 🎉