Skip to content
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.

Sign up for GitHub

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

Jump to bottom

docs: check if the disambiguator matches its suffix #127016

Merged
merged 2 commits into from
Jun 29, 2024
Merged

docs: check if the disambiguator matches its suffix #127016

merged 2 commits into from
Jun 29, 2024

Conversation

bvanjoi
Copy link
Contributor

@bvanjoi bvanjoi commented Jun 27, 2024

Fixes #126986

This PR makes it will not continue resolving when its disambiguator doesn't match the suffix format.

@rustbot
Copy link
Collaborator

rustbot commented Jun 27, 2024

r? @notriddle

rustbot has assigned @notriddle.
They will have a look at your PR within the next two weeks and either review your PR or reassign to another reviewer.

Use r? to explicitly pick a reviewer

@rustbot rustbot added S-waiting-on-review Status: Awaiting review from the assignee but also interested parties. T-rustdoc Relevant to the rustdoc team, which will review and decide on the PR/issue. labels Jun 27, 2024
@GuillaumeGomez
Copy link
Member

As far as I can see, it doesn't resolve #126986. The issue is that the macro is defined after the doc comment without #[macro_export], meaning that the compiler will only see it after the doc comment is processed.

@GuillaumeGomez
Copy link
Member

Just to add more information: maybe I'm wrong, but in this case, please add a test without #[macro_export] to confirm it and then it can be approved and merged.

@GuillaumeGomez
Copy link
Member

If CI is happy, I'll approve it. Thanks for working on this. :)

@notriddle
Copy link
Contributor

@bors r=GuillaumeGomez,notriddle

@bors
Copy link
Contributor

bors commented Jun 27, 2024

📌 Commit 6400a4f has been approved by GuillaumeGomez,notriddle

It is now in the queue for this repository.

@bors bors added S-waiting-on-bors Status: Waiting on bors to run and complete tests. Bors will change the label on completion. and removed S-waiting-on-review Status: Awaiting review from the assignee but also interested parties. labels Jun 27, 2024
GuillaumeGomez added a commit to GuillaumeGomez/rust that referenced this pull request Jun 27, 2024
@GuillaumeGomez
Rollup merge of rust-lang#127016 - bvanjoi:fix-126986, r=GuillaumeGom…
fd8a181 
…ez,notriddle

docs: check if the disambiguator matches its suffix

Fixes rust-lang#126986

This PR makes it will not continue resolving when its disambiguator doesn't match the suffix format.
@GuillaumeGomez GuillaumeGomez mentioned this pull request Jun 27, 2024
Closed
bors added a commit to rust-lang-ci/rust that referenced this pull request Jun 27, 2024
@bors
Auto merge of rust-lang#127046 - GuillaumeGomez:rollup-zny4j7m, r=Gui…
2cb0ec8 
…llaumeGomez

Rollup of 10 pull requests

Successful merges:

 - rust-lang#123237 (Various rustc_codegen_ssa cleanups)
 - rust-lang#123714 (Add test for fn pointer duplication.)
 - rust-lang#124091 (Update AST validation module docs)
 - rust-lang#126835 (Simplifications in match lowering)
 - rust-lang#126963 (Add basic Serde serialization capabilities to Stable MIR)
 - rust-lang#127010 (Update browser-ui-test version to `0.18.0`)
 - rust-lang#127015 (Switch back `non_local_definitions` lint to allow-by-default)
 - rust-lang#127016 (docs: check if the disambiguator matches its suffix)
 - rust-lang#127029 (Fix Markdown tables in platform-support.md)
 - rust-lang#127032 (Enable const casting for `f16` and `f128`)

r? `@ghost`
`@rustbot` modify labels: rollup
@GuillaumeGomez
Copy link
Member

Failed in #127046.

@bors r-

@bors bors added S-waiting-on-author Status: This is awaiting some action (such as code changes or more information) from the author. and removed S-waiting-on-bors Status: Waiting on bors to run and complete tests. Bors will change the label on completion. labels Jun 27, 2024
GuillaumeGomez
GuillaumeGomez reviewed Jun 27, 2024
View reviewed changes
tests/rustdoc-ui/disambiguator-endswith-named-suffix.rs
@@ -0,0 +1,110 @@
//@ check-pass
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

You need to add:

//@ normalize-stderr-test: "nightly|beta|1\.[0-9][0-9]\.[0-9]" -> "$$CHANNEL"

And then to remove and regenerate stderr files (for both tests).

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Is it necessary to add this header for disambiguator-macro-endswith-exclamatory, I'm not sure (because I haven't seen any related snapshots in it)

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It's only necessary if the stderr has a URL in it. That one doesn't.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Like they said. :)

@GuillaumeGomez
Copy link
Member

This time it should be all good to go. Thanks again!

@bors r+ rollup

@bors
Copy link
Contributor

bors commented Jun 28, 2024

📌 Commit 91d3ac7 has been approved by GuillaumeGomez

It is now in the queue for this repository.

@bors bors added S-waiting-on-bors Status: Waiting on bors to run and complete tests. Bors will change the label on completion. and removed S-waiting-on-author Status: This is awaiting some action (such as code changes or more information) from the author. labels Jun 28, 2024
GuillaumeGomez added a commit to GuillaumeGomez/rust that referenced this pull request Jun 28, 2024
@GuillaumeGomez
Rollup merge of rust-lang#127016 - bvanjoi:fix-126986, r=GuillaumeGomez
1d318be 
docs: check if the disambiguator matches its suffix

Fixes rust-lang#126986

This PR makes it will not continue resolving when its disambiguator doesn't match the suffix format.
@GuillaumeGomez GuillaumeGomez mentioned this pull request Jun 28, 2024
Closed
bors added a commit to rust-lang-ci/rust that referenced this pull request Jun 28, 2024
@bors
Auto merge of rust-lang#127079 - GuillaumeGomez:rollup-ciimias, r=Gui…
99b441a 
…llaumeGomez

Rollup of 10 pull requests

Successful merges:

 - rust-lang#123714 (Add test for fn pointer duplication.)
 - rust-lang#124091 (Update AST validation module docs)
 - rust-lang#126963 (Add basic Serde serialization capabilities to Stable MIR)
 - rust-lang#127015 (Switch back `non_local_definitions` lint to allow-by-default)
 - rust-lang#127016 (docs: check if the disambiguator matches its suffix)
 - rust-lang#127029 (Fix Markdown tables in platform-support.md)
 - rust-lang#127032 (Enable const casting for `f16` and `f128`)
 - rust-lang#127041 (Migrate `run-make/override-aliased-flags` to `rmake.rs`)
 - rust-lang#127045 (Rename `super_predicates_of` and similar queries to `explicit_*` to note that they're not elaborated)
 - rust-lang#127075 (rustc_data_structures: Explicitly check for 64-bit atomics support)

r? `@ghost`
`@rustbot` modify labels: rollup
@matthiaskrgr matthiaskrgr mentioned this pull request Jun 28, 2024
Merged
bors added a commit to rust-lang-ci/rust that referenced this pull request Jun 28, 2024
@bors
Auto merge of rust-lang#127096 - matthiaskrgr:rollup-kh7e0rh, r=matth…
ecebe68 
…iaskrgr

Rollup of 11 pull requests

Successful merges:

 - rust-lang#123714 (Add test for fn pointer duplication.)
 - rust-lang#124091 (Update AST validation module docs)
 - rust-lang#127015 (Switch back `non_local_definitions` lint to allow-by-default)
 - rust-lang#127016 (docs: check if the disambiguator matches its suffix)
 - rust-lang#127029 (Fix Markdown tables in platform-support.md)
 - rust-lang#127032 (Enable const casting for `f16` and `f128`)
 - rust-lang#127055 (Mark Hasher::finish as #[must_use])
 - rust-lang#127068 (Stall computing instance for drop shim until it has no unsubstituted const params)
 - rust-lang#127070 (add () to the marker_impls macro for ConstParamTy)
 - rust-lang#127071 (Remove (deprecated & unstable) {to,from}_bits pointer methods)
 - rust-lang#127078 (Enable full tools and profiler for LoongArch Linux targets)

r? `@ghost`
`@rustbot` modify labels: rollup
bors added a commit to rust-lang-ci/rust that referenced this pull request Jun 29, 2024
@bors
Auto merge of rust-lang#127096 - matthiaskrgr:rollup-kh7e0rh, r=matth…
2eb6511 
…iaskrgr

Rollup of 11 pull requests

Successful merges:

 - rust-lang#123714 (Add test for fn pointer duplication.)
 - rust-lang#124091 (Update AST validation module docs)
 - rust-lang#127015 (Switch back `non_local_definitions` lint to allow-by-default)
 - rust-lang#127016 (docs: check if the disambiguator matches its suffix)
 - rust-lang#127029 (Fix Markdown tables in platform-support.md)
 - rust-lang#127032 (Enable const casting for `f16` and `f128`)
 - rust-lang#127055 (Mark Hasher::finish as #[must_use])
 - rust-lang#127068 (Stall computing instance for drop shim until it has no unsubstituted const params)
 - rust-lang#127070 (add () to the marker_impls macro for ConstParamTy)
 - rust-lang#127071 (Remove (deprecated & unstable) {to,from}_bits pointer methods)
 - rust-lang#127078 (Enable full tools and profiler for LoongArch Linux targets)

r? `@ghost`
`@rustbot` modify labels: rollup
bors added a commit to rust-lang-ci/rust that referenced this pull request Jun 29, 2024
@bors
Auto merge of rust-lang#127096 - matthiaskrgr:rollup-kh7e0rh, r=matth…
d38cd22 
…iaskrgr

Rollup of 11 pull requests

Successful merges:

 - rust-lang#123714 (Add test for fn pointer duplication.)
 - rust-lang#124091 (Update AST validation module docs)
 - rust-lang#127015 (Switch back `non_local_definitions` lint to allow-by-default)
 - rust-lang#127016 (docs: check if the disambiguator matches its suffix)
 - rust-lang#127029 (Fix Markdown tables in platform-support.md)
 - rust-lang#127032 (Enable const casting for `f16` and `f128`)
 - rust-lang#127055 (Mark Hasher::finish as #[must_use])
 - rust-lang#127068 (Stall computing instance for drop shim until it has no unsubstituted const params)
 - rust-lang#127070 (add () to the marker_impls macro for ConstParamTy)
 - rust-lang#127071 (Remove (deprecated & unstable) {to,from}_bits pointer methods)
 - rust-lang#127078 (Enable full tools and profiler for LoongArch Linux targets)

r? `@ghost`
`@rustbot` modify labels: rollup
@bors bors merged commit ba6fe58 into rust-lang:master Jun 29, 2024
6 checks passed
@rustbot rustbot added this to the 1.81.0 milestone Jun 29, 2024
rust-timer added a commit to rust-lang-ci/rust that referenced this pull request Jun 29, 2024
@rust-timer
Unrolled build for rust-lang#127016
fb31e24 
Rollup merge of rust-lang#127016 - bvanjoi:fix-126986, r=GuillaumeGomez

docs: check if the disambiguator matches its suffix

Fixes rust-lang#126986

This PR makes it will not continue resolving when its disambiguator doesn't match the suffix format.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@notriddle notriddle notriddle left review comments

@GuillaumeGomez GuillaumeGomez GuillaumeGomez approved these changes

Assignees

@notriddle notriddle

Labels
S-waiting-on-bors Status: Waiting on bors to run and complete tests. Bors will change the label on completion. T-rustdoc Relevant to the rustdoc team, which will review and decide on the PR/issue.
Projects
None yet
Milestone
1.81.0
Development

Successfully merging this pull request may close these issues.

rustdoc: panic when using macro@ and ! for referencing a macro in documentation
5 participants
@bvanjoi @rustbot @GuillaumeGomez @notriddle @bors