-
Notifications
You must be signed in to change notification settings - Fork 13.6k
Closed
Labels
A-intra-doc-linksArea: Intra-doc links, the ability to link to items in docs by nameArea: Intra-doc links, the ability to link to items in docs by nameC-bugCategory: This is a bug.Category: This is a bug.T-rustdocRelevant to the rustdoc team, which will review and decide on the PR/issue.Relevant to the rustdoc team, which will review and decide on the PR/issue.
Description
Problem
Links created according to 1946-intra-rustdoc-links either don't work as expected or work with warning: `[...]` cannot be resolved, ignoring it...
.
Steps
- Go to https://rust-lang-nursery.github.io/futures-api-docs/0.3.0-alpha.18/futures/channel/mpsc/struct.TryRecvError.html.
- Click on
try_next
link.
It won't work correctly, but if we git clone https://github.com/rust-lang-nursery/futures-rs
cd futures-rs
- Change line
from
[`try_next`](Receiver::try_next)
to
[`try_next`](mpsc::Receiver::try_next())
or to
[`try_next`](futures_channel::mpsc::Receiver::try_next())
- After
cargo +nightly doc
we will get
warning: `[mpsc::Receiver::try_next]` cannot be resolved, ignoring it...
or
warning: `[futures_channel::mpsc::Receiver::try_next]` cannot be resolved, ignoring it...
respectively.
Meanwhile link will magically work.
Possible Solution(s)
It would be nice to remove incorrect warnings and make doc example work [or at least add warning for that case]. Thanks.
Notes
Output of cargo version
:
cargo 1.39.0-nightly (22f7dd049 2019-08-27)
Metadata
Metadata
Assignees
Labels
A-intra-doc-linksArea: Intra-doc links, the ability to link to items in docs by nameArea: Intra-doc links, the ability to link to items in docs by nameC-bugCategory: This is a bug.Category: This is a bug.T-rustdocRelevant to the rustdoc team, which will review and decide on the PR/issue.Relevant to the rustdoc team, which will review and decide on the PR/issue.