dnrops
/
rust
mirror of https://github.com/rust-lang/rust.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Add explanations for auto-disambiguation when an intra doc link is resolved to a proc-macro and a trait at the same time

This commit is contained in:
Guillaume Gomez 2023-04-14 20:21:07 +02:00
parent b76821b4de
commit d38fd29b5b
1 changed files with 7 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

7
src/doc/rustdoc/src/write-documentation/linking-to-items-by-name.md
View File

@ -103,6 +103,13 @@ macro_rules! foo {
}
```
There is one case where the disambiguation will be performed automatically: if an intra doc
link is resolved at the same time as a trait and as a derive proc-macro. In this case, it'll
always generate a link to the trait and not emit a "missing disambiguation" warning. A good
example of this case is when you link to the `Clone` trait: there is also a `Clone`
proc-macro but it ignores it in this case. If you want to link to the proc-macro, you can
use the `macro@` disambiguator.
## Warnings, re-exports, and scoping
Links are resolved in the scope of the module where the item is defined, even