Occurrences of a libstd or libextra item in the tutorial and manual should link to the docs for it

[steveklabnik]

Issue by lkuper
Monday May 27, 2013 at 04:42 GMT

For earlier discussion, see rust-lang/rust#6758

This issue was labelled with: A-rustdoc, E-hard, I-wishlist in the Rust repository

---

Masklinn recently suggested on rust-dev that it would be nice to have cross-linking within the generated HTML docs. E.g., an occurrence of "println" in the tutorial would be a link to here (if I understand the suggestion correctly). We could do this cross-linking for all top-level items: types, traits, functions, impls, etc.

I wouldn't expect this to happen for code blocks, just for inline code. Ideally, there would also be a way to turn it off -- both in the sense that we might want to be able to tell rustdoc not to do cross-linking on a particular run (to make the docs build faster), and in the sense that we might want to be able to specify that particular occurrences should never be cross-linked (because after a point it might hinder readability).

Presumably we'd also eventually want this cross-linking within the documentation itself, too, as well as in the tutorial and manual.

[Centril]

Closing in favor of rust-lang/rust#43466.