Intra-doc links do not work in markdown files #77974
Labels
A-intra-doc-links
Area: Intra-doc links, the ability to link to items in docs by name
A-markdown-parsing
Area: Markdown parsing for doc-comments
C-feature-request
Category: A feature request, i.e: not implemented / a PR.
E-medium
Call for participation: Medium difficulty. Experience needed to fix: Intermediate.
T-rustdoc
Relevant to the rustdoc team, which will review and decide on the PR/issue.
Comments
jyn514
added
T-rustdoc
jyn514
added a commit
to jyn514/book
that referenced
this issue
Oct 15, 2020
Intra-doc links do not yet work in markdown files; see rust-lang/rust#77974.
bors bot
added a commit
to rust-embedded/book
that referenced
this issue
Oct 15, 2020
271: Fix broken link to std::process::Command r=therealprof a=jyn514 Intra-doc links do not yet work in markdown files; see rust-lang/rust#77974. Part of rust-lang/rust#77971. Co-authored-by: Joshua Nelson <[email protected]>
|
#99466 came up with a fascinating solution: Add That doesn't actually work for intra-doc links because rustdoc runs in a different mode (that doesn't run the compiler internally) but I think it should be feasible to start loading crates when rendering markdown files :) which would make this exactly parallel to how rust source code works. |
jyn514
added
the
E-medium
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
I tried this code:
I expected to see this happen: Rustdoc generates a link to https://doc.rust-lang.org/std/process/struct.Command.html
Instead, this happened: Rustdoc writes the literal text
[std::process::Command]This might be a little tricky because there is no scope to resolve in. I think ideally this would have the same scope as an empty crate with only the
stdinjects (extern crate std; use std::prelude::v1::*;).Noticed this in #77971.
Meta
rustdoc --version:The text was updated successfully, but these errors were encountered: