Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Intra-doc link to use fails to resolve #78095

Closed
camelid opened this issue Oct 19, 2020 · 1 comment
Closed

Intra-doc link to use fails to resolve #78095

camelid opened this issue Oct 19, 2020 · 1 comment
Labels
A-intra-doc-links Area: Intra-doc links, the ability to link to items in docs by name C-bug Category: This is a bug. T-rustdoc Relevant to the rustdoc team, which will review and decide on the PR/issue.

Comments

@camelid
Copy link
Member

camelid commented Oct 19, 2020

See #78093 for an example:

error: unresolved link to `use`
  --> library/std/src/keyword_docs.rs:23:74
   |
23 | /// Other places `as` is used include as extra syntax for [`crate`] and [`use`], or to change
   |                                                                          ^^^^^ the module `std` contains no item named `use`
   |
   = note: `-D broken-intra-doc-links` implied by `-D warnings`
   = help: to escape `[` and `]` characters, add '\' before them like `\[` or `\]`

error: unresolved link to `use`
  --> library/std/src/keyword_docs.rs:23:74
   |
23 | /// Other places `as` is used include as extra syntax for [`crate`] and [`use`], or to change
   |                                                                          ^^^^^ the module `std` contains no item named `use`
   |
   = help: to escape `[` and `]` characters, add '\' before them like `\[` or `\]`
@camelid camelid added T-rustdoc Relevant to the rustdoc team, which will review and decide on the PR/issue. C-bug Category: This is a bug. A-intra-doc-links Area: Intra-doc links, the ability to link to items in docs by name labels Oct 19, 2020
@camelid
Copy link
Member Author

camelid commented Oct 19, 2020

Hmm, actually it looks like it happens for other keywords too. The reason crate works is because it's linking to the current crate, not the keyword 🤦

@camelid camelid closed this as completed Oct 19, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
A-intra-doc-links Area: Intra-doc links, the ability to link to items in docs by name C-bug Category: This is a bug. T-rustdoc Relevant to the rustdoc team, which will review and decide on the PR/issue.
Projects
None yet
Development

No branches or pull requests

1 participant