Skip to content

Broken intra-rustdoc-links #1903

@olegnn

Description

@olegnn
Contributor

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.

Activity

Nemo157

Nemo157 commented on Oct 8, 2019

@Nemo157
Member

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

Nemo157 commented on Oct 8, 2019

@Nemo157
Member

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

olegnn commented on Oct 8, 2019

@olegnn
ContributorAuthor

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

jyn514 commented on Jul 20, 2020

@jyn514
Member

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

taiki-e

taiki-e commented on Sep 5, 2020

@taiki-e
Member

Confirmed this has been fixed 🎉

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

      Development

      No branches or pull requests

        Participants

        @Nemo157@cramertj@olegnn@jyn514@taiki-e

        Issue actions

          Broken intra-rustdoc-links · Issue #1903 · rust-lang/futures-rs