Skip to content

intra-doc links: Links with unexpected characters are silently ignored #77199

Closed

Description

Intra-doc links with unexpected characters are ignored here:

if path_str.contains(|ch: char| !(ch.is_alphanumeric() || ch == ':' || ch == '_')) {
return;
}

However, it would be better if they caused a warning with --display-doctest-warnings. Developers might expect [`&[String]`] to link to the slice primitive, but that link would be ignored without a warning.

cc @jyn514
cc #76106 (comment)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Assignees

No one assigned

    Labels

    A-intra-doc-linksArea: Intra-doc links, the ability to link to items in docs by nameI-needs-decisionIssue: In need of a decision.T-rustdocRelevant to the rustdoc team, which will review and decide on the PR/issue.

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions