-
Notifications
You must be signed in to change notification settings - Fork 13.4k
rustdoc: linking to a local proc macro no longer warns #141411
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
bors
merged 1 commit into
rust-lang:master
from
lolbinarycat:rustdoc-link-proc-macro-91274
May 28, 2025
+84
−8
Merged
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,21 @@ | ||
//@ compile-flags: --crate-type=proc-macro --document-private-items | ||
#![deny(rustdoc::broken_intra_doc_links)] | ||
|
||
//! Link to [`m`]. | ||
//~^ ERROR `m` is both a module and a macro | ||
|
||
// test a further edge case related to https://github.com/rust-lang/rust/issues/91274 | ||
|
||
// we need to make sure that when there is actually an ambiguity | ||
// in a proc-macro crate, we print out a sensible error. | ||
// because proc macro crates can't normally export modules, | ||
// this can only happen in --document-private-items mode. | ||
|
||
extern crate proc_macro; | ||
|
||
mod m {} | ||
|
||
#[proc_macro] | ||
pub fn m(input: proc_macro::TokenStream) -> proc_macro::TokenStream { | ||
input | ||
} |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,22 @@ | ||
error: `m` is both a module and a macro | ||
--> $DIR/bad-link-to-proc-macro.rs:4:15 | ||
| | ||
LL | //! Link to [`m`]. | ||
| ^ ambiguous link | ||
| | ||
note: the lint level is defined here | ||
--> $DIR/bad-link-to-proc-macro.rs:2:9 | ||
| | ||
LL | #![deny(rustdoc::broken_intra_doc_links)] | ||
| ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ | ||
help: to link to the module, prefix with `mod@` | ||
| | ||
LL | //! Link to [`mod@m`]. | ||
| ++++ | ||
help: to link to the macro, add an exclamation mark | ||
| | ||
LL | //! Link to [`m!`]. | ||
| + | ||
|
||
error: aborting due to 1 previous error | ||
|
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,13 @@ | ||
//@ compile-flags: --crate-type=proc-macro | ||
//@ has 'foo/index.html' '//a[@href="macro.my_macro.html"]' 'my_macro' | ||
//! Link to [`my_macro`]. | ||
#![crate_name = "foo"] | ||
|
||
// regression test for https://github.com/rust-lang/rust/issues/91274 | ||
|
||
extern crate proc_macro; | ||
|
||
#[proc_macro] | ||
pub fn my_macro(input: proc_macro::TokenStream) -> proc_macro::TokenStream { | ||
input | ||
} |
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.