1946-intra-rustdoc-links issue · Issue #64193 · rust-lang/rust (original) (raw)

Skip to content

Navigation Menu

• • GitHub Copilot Write better code with AI
  • GitHub Advanced Security Find and fix vulnerabilities
  • Actions Automate any workflow
  • Codespaces Instant dev environments
  • Issues Plan and track work
  • Code Review Manage code changes
  • Discussions Collaborate outside of code
  • Code Search Find more, search less
• Explore
  • Learning Pathways
  • Events & Webinars
  • Ebooks & Whitepapers
  • Customer Stories
  • Partners
  • Executive Insights
• • GitHub Sponsors Fund open source developers
  • The ReadME Project GitHub community articles
• • Enterprise platform AI-powered developer platform
• Pricing

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Sign up

Appearance settings

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

1. Go to https://rust-lang-nursery.github.io/futures-api-docs/0.3.0-alpha.18/futures/channel/mpsc/struct.TryRecvError.html.
2. Click on try_next link.
   It won't work correctly, but if we
3. git clone https://github.com/rust-lang-nursery/futures-rs
4. cd futures-rs
5. 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())
6. 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)