improved help message for rustdoc::broken_intra_doc_links #132788
Labels
A-intra-doc-links
Area: Intra-doc links, the ability to link to items in docs by name
C-enhancement
Category: An issue proposing an enhancement or a PR with one.
T-rustdoc
Relevant to the rustdoc team, which will review and decide on the PR/issue.
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
The text was updated successfully, but these errors were encountered: