You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Detect references in comments of form `foo` where foo path is reachable in the current scope and thus the reference could be made into an intra-doc link. The reasoning is that references to other symbols will be highlighted and enriched with a link in the generated documentation. The intra-doc link will also be validated by rustdoc to stay valid, so this way the comment that references some paths will be guaranteed to have valid references.
Example code
Bad
/// This struct implements `crate::TraitName` in such a way that it does foo.structFoo;
Good
/// This struct implements [`crate::TraitName`] in such a way that it does foo.structFoo;
The text was updated successfully, but these errors were encountered:
Lint explanation
Detect references in comments of form
`foo`
wherefoo
path is reachable in the current scope and thus the reference could be made into an intra-doc link. The reasoning is that references to other symbols will be highlighted and enriched with a link in the generated documentation. The intra-doc link will also be validated byrustdoc
to stay valid, so this way the comment that references some paths will be guaranteed to have valid references.Example code
Bad
Good
The text was updated successfully, but these errors were encountered: