-
-
Notifications
You must be signed in to change notification settings - Fork 14.7k
improved help message for rustdoc::broken_intra_doc_links #132788
Copy link
Copy link
Open
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-enhancementCategory: An issue proposing an enhancement or a PR with one.Category: An issue proposing an enhancement or a PR with one.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.
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-enhancementCategory: An issue proposing an enhancement or a PR with one.Category: An issue proposing an enhancement or a PR with one.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.
Type
Fields
Give feedbackNo fields configured for issues without a type.
Currently, the only suggestion rustdoc gives is to simply escape
[and]with backslashes, or if there is a similarly-named item, to link to that instead.there are a few other common errors that it could catch though:
arr[idx+3]) should be surrounded by backticks instead of escaping each bracket individuallyinspired by discussion on #132748