-
-
Notifications
You must be signed in to change notification settings - Fork 14.9k
rustdoc: terse diagnostic on malformed intra-doc link (single instead of double colon) #141095
Copy link
Copy link
Open
Labels
A-diagnosticsArea: Messages for errors, warnings, and lintsArea: Messages for errors, warnings, and lintsA-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-feature-requestCategory: A feature request, i.e: not implemented / a PR.Category: A feature request, i.e: not implemented / a PR.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.
Description
Metadata
Metadata
Assignees
Labels
A-diagnosticsArea: Messages for errors, warnings, and lintsArea: Messages for errors, warnings, and lintsA-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-feature-requestCategory: A feature request, i.e: not implemented / a PR.Category: A feature request, i.e: not implemented / a PR.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.
Problem
I wrote:
but I meant to write
TextManager::atlasesThe error I got was:
But a better error (for my case) would have been referencing that I was missing a semicolon.
Proposed Solution
Since I believe any item cannot have a single
:in it, I propose the error should just lint for any illegal characters in a path.I understand this might be more complex because of partial paths, but I am not familiar enough with those to address them here.
Notes
No response