rustdoc: Take into account edition information for keyword highlighting - #161944

Merged
rust-bors[bot] merged 1 commit into
rust-lang:mainfrom
GuillaumeGomez:keyword-highlighting
Aug 30, 2026
Merged

rustdoc: Take into account edition information for keyword highlighting#161944
rust-bors[bot] merged 1 commit into
rust-lang:mainfrom
GuillaumeGomez:keyword-highlighting

Conversation

@GuillaumeGomez

Copy link
Copy Markdown
Member

Fixes#148221.

The only thing that was missing was passing down an Edition to the highlighter (and adding tests).

r? @fmease

@rustbotrustbot 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. T-rustdoc-frontend Relevant to the rustdoc-frontend team, which will review and decide on the web UI/UX output. labels Aug 28, 2026
@rust-log-analyzer

This comment has been minimized.

@rust-log-analyzer

This comment has been minimized.

@GuillaumeGomez
GuillaumeGomezforce-pushed the keyword-highlighting branch 2 times, most recently from 1e831c0 to 05a128cCompareAugust 28, 2026 21:04
@GuillaumeGomez

Copy link
Copy Markdown
MemberAuthor

Cleaned up all my mess. Ready for review.

@fmeasefmease left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Thanks! :)

I've also tested markdown input rustdoc *.md --edition * and that works, too, automatically.

Two nitpicks, otherwise r=me

View changes since this review

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Isn't source-code-pages/ for testing the contents of source code pages *.rs.html only? Here however, we're testing how the code blocks are rendered on "API pages", aren't we?

IIRC this belongs into tests/rustdoc-html/doctest/.

Copy link
Copy Markdown
MemberAuthor

Choose a reason for hiding this comment

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

Fair enough!

&code,
None,
None,
original_span.edition(),

@fmeasefmeaseAug 29, 2026

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Could you add a // NOTE: here that states that this is only "an approximation" or "best effort" since the edition of individual tokens contained in the expansion can differ from the "overarching edition" / the edition of the entire expansion (original_span.edition()).

And we can't fix that since code is just a String that was produced by rustc_ast_pretty meaning more precise edition information has been lost.


To give an example:

//@ edition: 2015#[macro_export]macro_rules! generate {($kw:ident) => {pubfn host(){let _ = $kw {};}};}
//@ edition: 2024
dependency::generate!(async);

Here, your PR doesn't highlight the async in the rendered expansion … let _ = async {} … since it uses the edition of the entire expansion (which is Rust 2015) but the async in the Rust 2015 expansion does actually refer to Rust 2024 keyword async and thus contains an async block, not a struct expression! That's because the keyword async originates from a Rust 2024 crate (root expansion).1

I think that's perfectly acceptable for now but a NOTE would be nice.

Footnotes

  1. Or vice versa: The dependency is Rust 2024 and the dependent is Rust 2015. In such a case, the keyword currently gets highlighted even though it shouldn't be.

@fmeasefmease 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-review Status: Awaiting review from the assignee but also interested parties. labels Aug 29, 2026
@GuillaumeGomez

Copy link
Copy Markdown
MemberAuthor

Applied suggestions (and mostly took your comment for the note because I think it's more than enough hehe).

@GuillaumeGomez

Copy link
Copy Markdown
MemberAuthor

@bors r=fmease rollup

@rust-bors

rust-borsBot commented Aug 29, 2026

Copy link
Copy Markdown
Contributor

📌 Commit 40dc901 has been approved by fmease

It is now in the queue for this repository.

@rust-borsrust-borsBot 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 Aug 29, 2026
JonathanBrouwer added a commit to JonathanBrouwer/rust that referenced this pull request Aug 29, 2026
…g, r=fmease
rustdoc: Take into account edition information for keyword highlighting
Fixesrust-lang#148221.
The only thing that was missing was passing down an `Edition` to the highlighter (and adding tests).
r? @fmease
JonathanBrouwer added a commit to JonathanBrouwer/rust that referenced this pull request Aug 29, 2026
…g, r=fmease
rustdoc: Take into account edition information for keyword highlighting
Fixesrust-lang#148221.
The only thing that was missing was passing down an `Edition` to the highlighter (and adding tests).
r? @fmease
GuillaumeGomez added a commit to GuillaumeGomez/rust that referenced this pull request Aug 29, 2026
… r=fmease
Move rustdoc ui doctests into the right testsuite
When working on rust-lang#161944 (comment), I realized that a lot of doctests in `rustdoc-html` testsuite were not in the correct testsuite, so moving them in the right location.
Because you're the one who made me realize it, here goes @fmease (thanks!) :p
r? @fmease
rust-borsBot pushed a commit that referenced this pull request Aug 29, 2026
Rollup of 7 pull requests
Successful merges:
- #160941 (Enforce safety comments on `alloc`)
- #161975 (Abort instead of unwinding out of an inconsistent BTreeMap::split_off)
- #157968 (Preserve ambiguous glob lint for subtrait method picks)
- #161514 (rework handling of doc attributes on macro calls)
- #161944 (rustdoc: Take into account edition information for keyword highlighting)
- #161974 (remove rustc_never_type_options attr remnants)
- #161978 (Move rustdoc ui doctests into the right testsuite)
Failed merges:
- #161702 (Use `drop_guard` in some places in {core,alloc,std})
@rust-bors
rust-borsBot merged commit b41b7bb into rust-lang:mainAug 30, 2026
13 checks passed
@rustbotrustbot added this to the 1.100.0 milestone Aug 30, 2026
rust-borsBot pushed a commit that referenced this pull request Aug 30, 2026
Rollup merge of #161944 - GuillaumeGomez:keyword-highlighting, r=fmease
rustdoc: Take into account edition information for keyword highlighting
Fixes#148221.
The only thing that was missing was passing down an `Edition` to the highlighter (and adding tests).
r? @fmease
rust-borsBot pushed a commit that referenced this pull request Aug 30, 2026
Rollup merge of #161978 - GuillaumeGomez:cleanup-ui-doctest, r=fmease
Move rustdoc ui doctests into the right testsuite
When working on #161944 (comment), I realized that a lot of doctests in `rustdoc-html` testsuite were not in the correct testsuite, so moving them in the right location.
Because you're the one who made me realize it, here goes @fmease (thanks!) :p
r? @fmease
@GuillaumeGomez
GuillaumeGomez deleted the keyword-highlighting branch August 30, 2026 13:56
GuillaumeGomez added a commit to GuillaumeGomez/rust that referenced this pull request Aug 31, 2026
…ease
Move more `rustdoc-html` tests using `--test` into the right folder
Follow-up of rust-lang#161944.
I double-checked if more `rustdoc-html` tests were in the wrong folder and... yeah. So fixing that too. I'll send a patch to prevent that in the future (in `compiletest` I guess, doesn't seem like a `tidy` thing).
Oh also second commit is me realizing that some ui tests were using `compile-args` (which doesn't exist anymore) and without `@`. Anyway, fixed that too.
r? @fmease
JonathanBrouwer added a commit to JonathanBrouwer/rust that referenced this pull request Aug 31, 2026
…ease
Move more `rustdoc-html` tests using `--test` into the right folder
Follow-up of rust-lang#161944.
I double-checked if more `rustdoc-html` tests were in the wrong folder and... yeah. So fixing that too. I'll send a patch to prevent that in the future (in `compiletest` I guess, doesn't seem like a `tidy` thing).
Oh also second commit is me realizing that some ui tests were using `compile-args` (which doesn't exist anymore) and without `@`. Anyway, fixed that too.
r? @fmease
jhpratt added a commit to jhpratt/rust that referenced this pull request Sep 1, 2026
…ease
Move more `rustdoc-html` tests using `--test` into the right folder
Follow-up of rust-lang#161944.
I double-checked if more `rustdoc-html` tests were in the wrong folder and... yeah. So fixing that too. I'll send a patch to prevent that in the future (in `compiletest` I guess, doesn't seem like a `tidy` thing).
Oh also second commit is me realizing that some ui tests were using `compile-args` (which doesn't exist anymore) and without `@`. Anyway, fixed that too.
r? @fmease
JonathanBrouwer added a commit to JonathanBrouwer/rust that referenced this pull request Sep 1, 2026
…ease
Move more `rustdoc-html` tests using `--test` into the right folder
Follow-up of rust-lang#161944.
I double-checked if more `rustdoc-html` tests were in the wrong folder and... yeah. So fixing that too. I'll send a patch to prevent that in the future (in `compiletest` I guess, doesn't seem like a `tidy` thing).
Oh also second commit is me realizing that some ui tests were using `compile-args` (which doesn't exist anymore) and without `@`. Anyway, fixed that too.
r? @fmease
JonathanBrouwer added a commit to JonathanBrouwer/rust that referenced this pull request Sep 1, 2026
…ease
Move more `rustdoc-html` tests using `--test` into the right folder
Follow-up of rust-lang#161944.
I double-checked if more `rustdoc-html` tests were in the wrong folder and... yeah. So fixing that too. I'll send a patch to prevent that in the future (in `compiletest` I guess, doesn't seem like a `tidy` thing).
Oh also second commit is me realizing that some ui tests were using `compile-args` (which doesn't exist anymore) and without `@`. Anyway, fixed that too.
r? @fmease
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Labels

S-waiting-on-borsStatus: Waiting on bors to run and complete tests. Bors will change the label on completion.T-rustdocRelevant to the rustdoc team, which will review and decide on the PR/issue.T-rustdoc-frontendRelevant to the rustdoc-frontend team, which will review and decide on the web UI/UX output.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

rustdoc: Source code pages & code blocks should be highlighted according to the requested / ambient edition

4 participants

@GuillaumeGomez@rust-log-analyzer@fmease@rustbot
, 'i'); if (__m === '*' || __re.test(location.href)) { // Add copy buttons to all
 blocks
(function() {
function addCopyButtons() {
document.querySelectorAll('pre code').forEach(function(codeBlock) {
if (codeBlock.parentElement.hasAttribute('data-copy-added')) return;
codeBlock.parentElement.setAttribute('data-copy-added', 'true');
var btn = document.createElement('button');
btn.textContent = 'Copy';
btn.style.cssText = 'position:absolute;top:4px;right:4px;padding:2px 8px;font-size:11px;background:#4ecdc4;border:none;border-radius:4px;color:#1a1a2e;cursor:pointer;opacity:0.7;transition:opacity 0.2s;';
btn.onmouseover = function() { this.style.opacity = '1'; };
btn.onmouseout = function() { this.style.opacity = '0.7'; };
btn.onclick = function() {
navigator.clipboard.writeText(codeBlock.textContent).then(function() {
btn.textContent = 'Copied!';
setTimeout(function() { btn.textContent = 'Copy'; }, 1500);
});
};
codeBlock.parentElement.style.position = 'relative';
codeBlock.parentElement.appendChild(btn);
});
}
addCopyButtons();
// Re-run on dynamic content
var observer = new MutationObserver(addCopyButtons);
observer.observe(document.body, { childList: true, subtree: true });
})();
}
} catch(__e) { console.warn('[Userscript:Add Copy Buttons to Code Blocks]', __e); }
})();
(function(){
try {
var __m = "github.com";
var __re = new RegExp('^' + "github\\.com" + '
Skip to content

rustdoc: Take into account edition information for keyword highlighting - #161944

Merged
rust-bors[bot] merged 1 commit into
rust-lang:mainfrom
GuillaumeGomez:keyword-highlighting
Aug 30, 2026
Merged

rustdoc: Take into account edition information for keyword highlighting#161944
rust-bors[bot] merged 1 commit into
rust-lang:mainfrom
GuillaumeGomez:keyword-highlighting

Conversation

@GuillaumeGomez

Copy link
Copy Markdown
Member

Fixes#148221.

The only thing that was missing was passing down an Edition to the highlighter (and adding tests).

r? @fmease

@rustbotrustbot 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. T-rustdoc-frontend Relevant to the rustdoc-frontend team, which will review and decide on the web UI/UX output. labels Aug 28, 2026
@rust-log-analyzer

This comment has been minimized.

@rust-log-analyzer

This comment has been minimized.

@GuillaumeGomez
GuillaumeGomezforce-pushed the keyword-highlighting branch 2 times, most recently from 1e831c0 to 05a128cCompareAugust 28, 2026 21:04
@GuillaumeGomez

Copy link
Copy Markdown
MemberAuthor

Cleaned up all my mess. Ready for review.

@fmeasefmease left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Thanks! :)

I've also tested markdown input rustdoc *.md --edition * and that works, too, automatically.

Two nitpicks, otherwise r=me

View changes since this review

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Isn't source-code-pages/ for testing the contents of source code pages *.rs.html only? Here however, we're testing how the code blocks are rendered on "API pages", aren't we?

IIRC this belongs into tests/rustdoc-html/doctest/.

Copy link
Copy Markdown
MemberAuthor

Choose a reason for hiding this comment

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

Fair enough!

&code,
None,
None,
original_span.edition(),

@fmeasefmeaseAug 29, 2026

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Could you add a // NOTE: here that states that this is only "an approximation" or "best effort" since the edition of individual tokens contained in the expansion can differ from the "overarching edition" / the edition of the entire expansion (original_span.edition()).

And we can't fix that since code is just a String that was produced by rustc_ast_pretty meaning more precise edition information has been lost.


To give an example:

//@ edition: 2015#[macro_export]macro_rules! generate {($kw:ident) => {pubfn host(){let _ = $kw {};}};}
//@ edition: 2024
dependency::generate!(async);

Here, your PR doesn't highlight the async in the rendered expansion … let _ = async {} … since it uses the edition of the entire expansion (which is Rust 2015) but the async in the Rust 2015 expansion does actually refer to Rust 2024 keyword async and thus contains an async block, not a struct expression! That's because the keyword async originates from a Rust 2024 crate (root expansion).1

I think that's perfectly acceptable for now but a NOTE would be nice.

Footnotes

  1. Or vice versa: The dependency is Rust 2024 and the dependent is Rust 2015. In such a case, the keyword currently gets highlighted even though it shouldn't be.

@fmeasefmease 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-review Status: Awaiting review from the assignee but also interested parties. labels Aug 29, 2026
@GuillaumeGomez

Copy link
Copy Markdown
MemberAuthor

Applied suggestions (and mostly took your comment for the note because I think it's more than enough hehe).

@GuillaumeGomez

Copy link
Copy Markdown
MemberAuthor

@bors r=fmease rollup

@rust-bors

rust-borsBot commented Aug 29, 2026

Copy link
Copy Markdown
Contributor

📌 Commit 40dc901 has been approved by fmease

It is now in the queue for this repository.

@rust-borsrust-borsBot 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 Aug 29, 2026
JonathanBrouwer added a commit to JonathanBrouwer/rust that referenced this pull request Aug 29, 2026
…g, r=fmease
rustdoc: Take into account edition information for keyword highlighting
Fixesrust-lang#148221.
The only thing that was missing was passing down an `Edition` to the highlighter (and adding tests).
r? @fmease
JonathanBrouwer added a commit to JonathanBrouwer/rust that referenced this pull request Aug 29, 2026
…g, r=fmease
rustdoc: Take into account edition information for keyword highlighting
Fixesrust-lang#148221.
The only thing that was missing was passing down an `Edition` to the highlighter (and adding tests).
r? @fmease
GuillaumeGomez added a commit to GuillaumeGomez/rust that referenced this pull request Aug 29, 2026
… r=fmease
Move rustdoc ui doctests into the right testsuite
When working on rust-lang#161944 (comment), I realized that a lot of doctests in `rustdoc-html` testsuite were not in the correct testsuite, so moving them in the right location.
Because you're the one who made me realize it, here goes @fmease (thanks!) :p
r? @fmease
rust-borsBot pushed a commit that referenced this pull request Aug 29, 2026
Rollup of 7 pull requests
Successful merges:
- #160941 (Enforce safety comments on `alloc`)
- #161975 (Abort instead of unwinding out of an inconsistent BTreeMap::split_off)
- #157968 (Preserve ambiguous glob lint for subtrait method picks)
- #161514 (rework handling of doc attributes on macro calls)
- #161944 (rustdoc: Take into account edition information for keyword highlighting)
- #161974 (remove rustc_never_type_options attr remnants)
- #161978 (Move rustdoc ui doctests into the right testsuite)
Failed merges:
- #161702 (Use `drop_guard` in some places in {core,alloc,std})
@rust-bors
rust-borsBot merged commit b41b7bb into rust-lang:mainAug 30, 2026
13 checks passed
@rustbotrustbot added this to the 1.100.0 milestone Aug 30, 2026
rust-borsBot pushed a commit that referenced this pull request Aug 30, 2026
Rollup merge of #161944 - GuillaumeGomez:keyword-highlighting, r=fmease
rustdoc: Take into account edition information for keyword highlighting
Fixes#148221.
The only thing that was missing was passing down an `Edition` to the highlighter (and adding tests).
r? @fmease
rust-borsBot pushed a commit that referenced this pull request Aug 30, 2026
Rollup merge of #161978 - GuillaumeGomez:cleanup-ui-doctest, r=fmease
Move rustdoc ui doctests into the right testsuite
When working on #161944 (comment), I realized that a lot of doctests in `rustdoc-html` testsuite were not in the correct testsuite, so moving them in the right location.
Because you're the one who made me realize it, here goes @fmease (thanks!) :p
r? @fmease
@GuillaumeGomez
GuillaumeGomez deleted the keyword-highlighting branch August 30, 2026 13:56
GuillaumeGomez added a commit to GuillaumeGomez/rust that referenced this pull request Aug 31, 2026
…ease
Move more `rustdoc-html` tests using `--test` into the right folder
Follow-up of rust-lang#161944.
I double-checked if more `rustdoc-html` tests were in the wrong folder and... yeah. So fixing that too. I'll send a patch to prevent that in the future (in `compiletest` I guess, doesn't seem like a `tidy` thing).
Oh also second commit is me realizing that some ui tests were using `compile-args` (which doesn't exist anymore) and without `@`. Anyway, fixed that too.
r? @fmease
JonathanBrouwer added a commit to JonathanBrouwer/rust that referenced this pull request Aug 31, 2026
…ease
Move more `rustdoc-html` tests using `--test` into the right folder
Follow-up of rust-lang#161944.
I double-checked if more `rustdoc-html` tests were in the wrong folder and... yeah. So fixing that too. I'll send a patch to prevent that in the future (in `compiletest` I guess, doesn't seem like a `tidy` thing).
Oh also second commit is me realizing that some ui tests were using `compile-args` (which doesn't exist anymore) and without `@`. Anyway, fixed that too.
r? @fmease
jhpratt added a commit to jhpratt/rust that referenced this pull request Sep 1, 2026
…ease
Move more `rustdoc-html` tests using `--test` into the right folder
Follow-up of rust-lang#161944.
I double-checked if more `rustdoc-html` tests were in the wrong folder and... yeah. So fixing that too. I'll send a patch to prevent that in the future (in `compiletest` I guess, doesn't seem like a `tidy` thing).
Oh also second commit is me realizing that some ui tests were using `compile-args` (which doesn't exist anymore) and without `@`. Anyway, fixed that too.
r? @fmease
JonathanBrouwer added a commit to JonathanBrouwer/rust that referenced this pull request Sep 1, 2026
…ease
Move more `rustdoc-html` tests using `--test` into the right folder
Follow-up of rust-lang#161944.
I double-checked if more `rustdoc-html` tests were in the wrong folder and... yeah. So fixing that too. I'll send a patch to prevent that in the future (in `compiletest` I guess, doesn't seem like a `tidy` thing).
Oh also second commit is me realizing that some ui tests were using `compile-args` (which doesn't exist anymore) and without `@`. Anyway, fixed that too.
r? @fmease
JonathanBrouwer added a commit to JonathanBrouwer/rust that referenced this pull request Sep 1, 2026
…ease
Move more `rustdoc-html` tests using `--test` into the right folder
Follow-up of rust-lang#161944.
I double-checked if more `rustdoc-html` tests were in the wrong folder and... yeah. So fixing that too. I'll send a patch to prevent that in the future (in `compiletest` I guess, doesn't seem like a `tidy` thing).
Oh also second commit is me realizing that some ui tests were using `compile-args` (which doesn't exist anymore) and without `@`. Anyway, fixed that too.
r? @fmease
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Labels

S-waiting-on-borsStatus: Waiting on bors to run and complete tests. Bors will change the label on completion.T-rustdocRelevant to the rustdoc team, which will review and decide on the PR/issue.T-rustdoc-frontendRelevant to the rustdoc-frontend team, which will review and decide on the web UI/UX output.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

rustdoc: Source code pages & code blocks should be highlighted according to the requested / ambient edition

4 participants

@GuillaumeGomez@rust-log-analyzer@fmease@rustbot
, 'i'); if (__m === '*' || __re.test(location.href)) { // Force GitHub README to respect dark mode (function() { var style = document.createElement('style'); style.textContent = ' .markdown-body { color-scheme: dark light; } .markdown-body pre { background: #161b22 !important; } .markdown-body code { background: rgba(110, 118, 129, 0.4) !important; } .markdown-body table th, .markdown-body table td { border-color: #30363d !important; } .markdown-body img { background: #0d1117; } .markdown-body blockquote { border-left-color: #8b949e; } .markdown-body hr { border-color: #30363d; } '; document.head.appendChild(style); })(); } } catch(__e) { console.warn('[Userscript:GitHub Dark Mode README Fix]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + '
Skip to content

rustdoc: Take into account edition information for keyword highlighting - #161944

Merged
rust-bors[bot] merged 1 commit into
rust-lang:mainfrom
GuillaumeGomez:keyword-highlighting
Aug 30, 2026
Merged

rustdoc: Take into account edition information for keyword highlighting#161944
rust-bors[bot] merged 1 commit into
rust-lang:mainfrom
GuillaumeGomez:keyword-highlighting

Conversation

@GuillaumeGomez

Copy link
Copy Markdown
Member

Fixes#148221.

The only thing that was missing was passing down an Edition to the highlighter (and adding tests).

r? @fmease

@rustbotrustbot 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. T-rustdoc-frontend Relevant to the rustdoc-frontend team, which will review and decide on the web UI/UX output. labels Aug 28, 2026
@rust-log-analyzer

This comment has been minimized.

@rust-log-analyzer

This comment has been minimized.

@GuillaumeGomez
GuillaumeGomezforce-pushed the keyword-highlighting branch 2 times, most recently from 1e831c0 to 05a128cCompareAugust 28, 2026 21:04
@GuillaumeGomez

Copy link
Copy Markdown
MemberAuthor

Cleaned up all my mess. Ready for review.

@fmeasefmease left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Thanks! :)

I've also tested markdown input rustdoc *.md --edition * and that works, too, automatically.

Two nitpicks, otherwise r=me

View changes since this review

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Isn't source-code-pages/ for testing the contents of source code pages *.rs.html only? Here however, we're testing how the code blocks are rendered on "API pages", aren't we?

IIRC this belongs into tests/rustdoc-html/doctest/.

Copy link
Copy Markdown
MemberAuthor

Choose a reason for hiding this comment

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

Fair enough!

&code,
None,
None,
original_span.edition(),

@fmeasefmeaseAug 29, 2026

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Could you add a // NOTE: here that states that this is only "an approximation" or "best effort" since the edition of individual tokens contained in the expansion can differ from the "overarching edition" / the edition of the entire expansion (original_span.edition()).

And we can't fix that since code is just a String that was produced by rustc_ast_pretty meaning more precise edition information has been lost.


To give an example:

//@ edition: 2015#[macro_export]macro_rules! generate {($kw:ident) => {pubfn host(){let _ = $kw {};}};}
//@ edition: 2024
dependency::generate!(async);

Here, your PR doesn't highlight the async in the rendered expansion … let _ = async {} … since it uses the edition of the entire expansion (which is Rust 2015) but the async in the Rust 2015 expansion does actually refer to Rust 2024 keyword async and thus contains an async block, not a struct expression! That's because the keyword async originates from a Rust 2024 crate (root expansion).1

I think that's perfectly acceptable for now but a NOTE would be nice.

Footnotes

  1. Or vice versa: The dependency is Rust 2024 and the dependent is Rust 2015. In such a case, the keyword currently gets highlighted even though it shouldn't be.

@fmeasefmease 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-review Status: Awaiting review from the assignee but also interested parties. labels Aug 29, 2026
@GuillaumeGomez

Copy link
Copy Markdown
MemberAuthor

Applied suggestions (and mostly took your comment for the note because I think it's more than enough hehe).

@GuillaumeGomez

Copy link
Copy Markdown
MemberAuthor

@bors r=fmease rollup

@rust-bors

rust-borsBot commented Aug 29, 2026

Copy link
Copy Markdown
Contributor

📌 Commit 40dc901 has been approved by fmease

It is now in the queue for this repository.

@rust-borsrust-borsBot 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 Aug 29, 2026
JonathanBrouwer added a commit to JonathanBrouwer/rust that referenced this pull request Aug 29, 2026
…g, r=fmease
rustdoc: Take into account edition information for keyword highlighting
Fixesrust-lang#148221.
The only thing that was missing was passing down an `Edition` to the highlighter (and adding tests).
r? @fmease
JonathanBrouwer added a commit to JonathanBrouwer/rust that referenced this pull request Aug 29, 2026
…g, r=fmease
rustdoc: Take into account edition information for keyword highlighting
Fixesrust-lang#148221.
The only thing that was missing was passing down an `Edition` to the highlighter (and adding tests).
r? @fmease
GuillaumeGomez added a commit to GuillaumeGomez/rust that referenced this pull request Aug 29, 2026
… r=fmease
Move rustdoc ui doctests into the right testsuite
When working on rust-lang#161944 (comment), I realized that a lot of doctests in `rustdoc-html` testsuite were not in the correct testsuite, so moving them in the right location.
Because you're the one who made me realize it, here goes @fmease (thanks!) :p
r? @fmease
rust-borsBot pushed a commit that referenced this pull request Aug 29, 2026
Rollup of 7 pull requests
Successful merges:
- #160941 (Enforce safety comments on `alloc`)
- #161975 (Abort instead of unwinding out of an inconsistent BTreeMap::split_off)
- #157968 (Preserve ambiguous glob lint for subtrait method picks)
- #161514 (rework handling of doc attributes on macro calls)
- #161944 (rustdoc: Take into account edition information for keyword highlighting)
- #161974 (remove rustc_never_type_options attr remnants)
- #161978 (Move rustdoc ui doctests into the right testsuite)
Failed merges:
- #161702 (Use `drop_guard` in some places in {core,alloc,std})
@rust-bors
rust-borsBot merged commit b41b7bb into rust-lang:mainAug 30, 2026
13 checks passed
@rustbotrustbot added this to the 1.100.0 milestone Aug 30, 2026
rust-borsBot pushed a commit that referenced this pull request Aug 30, 2026
Rollup merge of #161944 - GuillaumeGomez:keyword-highlighting, r=fmease
rustdoc: Take into account edition information for keyword highlighting
Fixes#148221.
The only thing that was missing was passing down an `Edition` to the highlighter (and adding tests).
r? @fmease
rust-borsBot pushed a commit that referenced this pull request Aug 30, 2026
Rollup merge of #161978 - GuillaumeGomez:cleanup-ui-doctest, r=fmease
Move rustdoc ui doctests into the right testsuite
When working on #161944 (comment), I realized that a lot of doctests in `rustdoc-html` testsuite were not in the correct testsuite, so moving them in the right location.
Because you're the one who made me realize it, here goes @fmease (thanks!) :p
r? @fmease
@GuillaumeGomez
GuillaumeGomez deleted the keyword-highlighting branch August 30, 2026 13:56
GuillaumeGomez added a commit to GuillaumeGomez/rust that referenced this pull request Aug 31, 2026
…ease
Move more `rustdoc-html` tests using `--test` into the right folder
Follow-up of rust-lang#161944.
I double-checked if more `rustdoc-html` tests were in the wrong folder and... yeah. So fixing that too. I'll send a patch to prevent that in the future (in `compiletest` I guess, doesn't seem like a `tidy` thing).
Oh also second commit is me realizing that some ui tests were using `compile-args` (which doesn't exist anymore) and without `@`. Anyway, fixed that too.
r? @fmease
JonathanBrouwer added a commit to JonathanBrouwer/rust that referenced this pull request Aug 31, 2026
…ease
Move more `rustdoc-html` tests using `--test` into the right folder
Follow-up of rust-lang#161944.
I double-checked if more `rustdoc-html` tests were in the wrong folder and... yeah. So fixing that too. I'll send a patch to prevent that in the future (in `compiletest` I guess, doesn't seem like a `tidy` thing).
Oh also second commit is me realizing that some ui tests were using `compile-args` (which doesn't exist anymore) and without `@`. Anyway, fixed that too.
r? @fmease
jhpratt added a commit to jhpratt/rust that referenced this pull request Sep 1, 2026
…ease
Move more `rustdoc-html` tests using `--test` into the right folder
Follow-up of rust-lang#161944.
I double-checked if more `rustdoc-html` tests were in the wrong folder and... yeah. So fixing that too. I'll send a patch to prevent that in the future (in `compiletest` I guess, doesn't seem like a `tidy` thing).
Oh also second commit is me realizing that some ui tests were using `compile-args` (which doesn't exist anymore) and without `@`. Anyway, fixed that too.
r? @fmease
JonathanBrouwer added a commit to JonathanBrouwer/rust that referenced this pull request Sep 1, 2026
…ease
Move more `rustdoc-html` tests using `--test` into the right folder
Follow-up of rust-lang#161944.
I double-checked if more `rustdoc-html` tests were in the wrong folder and... yeah. So fixing that too. I'll send a patch to prevent that in the future (in `compiletest` I guess, doesn't seem like a `tidy` thing).
Oh also second commit is me realizing that some ui tests were using `compile-args` (which doesn't exist anymore) and without `@`. Anyway, fixed that too.
r? @fmease
JonathanBrouwer added a commit to JonathanBrouwer/rust that referenced this pull request Sep 1, 2026
…ease
Move more `rustdoc-html` tests using `--test` into the right folder
Follow-up of rust-lang#161944.
I double-checked if more `rustdoc-html` tests were in the wrong folder and... yeah. So fixing that too. I'll send a patch to prevent that in the future (in `compiletest` I guess, doesn't seem like a `tidy` thing).
Oh also second commit is me realizing that some ui tests were using `compile-args` (which doesn't exist anymore) and without `@`. Anyway, fixed that too.
r? @fmease
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Labels

S-waiting-on-borsStatus: Waiting on bors to run and complete tests. Bors will change the label on completion.T-rustdocRelevant to the rustdoc team, which will review and decide on the PR/issue.T-rustdoc-frontendRelevant to the rustdoc-frontend team, which will review and decide on the web UI/UX output.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

rustdoc: Source code pages & code blocks should be highlighted according to the requested / ambient edition

4 participants

@GuillaumeGomez@rust-log-analyzer@fmease@rustbot
, 'i'); if (__m === '*' || __re.test(location.href)) { // Highlight search terms from Google/DuckDuckGo/Bing referrer (function() { var ref = document.referrer; var terms = []; if (ref.includes('google.com') || ref.includes('duckduckgo.com') || ref.includes('bing.com')) { var url = new URL(ref); var q = url.searchParams.get('q') || url.searchParams.get('p'); if (q) { terms = q.split(/\s+/).filter(function(t) { return t.length > 2; }); } } if (terms.length === 0) return; var style = document.createElement('style'); style.textContent = '.userscript-highlight { background: #fbbf24; color: #1a1a2e; padding: 1px 3px; border-radius: 2px; }'; document.head.appendChild(style); function highlight(node) { if (node.nodeType === 3) { // text node var text = node.textContent; var found = false; terms.forEach(function(term) { var regex = new RegExp('(' + term.replace(/[.*+?^${}()|[\]\\]/g, '\\') + ')', 'gi'); if (regex.test(text)) { found = true; var frag = document.createDocumentFragment(); var parts = text.split(regex); parts.forEach(function(part, i) { if (i % 2 === 0) { frag.appendChild(document.createTextNode(part)); } else { var span = document.createElement('span'); span.className = 'userscript-highlight'; span.textContent = part; frag.appendChild(span); } }); node.parentNode.replaceChild(frag, node); } }); } else if (node.nodeType === 1 && node.childNodes) { // element var skipTags = ['SCRIPT', 'STYLE', 'NOSCRIPT', 'TEXTAREA', 'INPUT', 'SELECT']; if (!skipTags.includes(node.tagName)) { Array.from(node.childNodes).forEach(highlight); } } } highlight(document.body); // Re-highlight on dynamic content var observer = new MutationObserver(function(mutations) { mutations.forEach(function(m) { m.addedNodes.forEach(function(node) { if (node.nodeType === 1 || node.nodeType === 3) highlight(node); }); }); }); observer.observe(document.body, { childList: true, subtree: true }); })(); } } catch(__e) { console.warn('[Userscript:Highlight Search Terms]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + '
Skip to content

rustdoc: Take into account edition information for keyword highlighting - #161944

Merged
rust-bors[bot] merged 1 commit into
rust-lang:mainfrom
GuillaumeGomez:keyword-highlighting
Aug 30, 2026
Merged

rustdoc: Take into account edition information for keyword highlighting#161944
rust-bors[bot] merged 1 commit into
rust-lang:mainfrom
GuillaumeGomez:keyword-highlighting

Conversation

@GuillaumeGomez

Copy link
Copy Markdown
Member

Fixes#148221.

The only thing that was missing was passing down an Edition to the highlighter (and adding tests).

r? @fmease

@rustbotrustbot 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. T-rustdoc-frontend Relevant to the rustdoc-frontend team, which will review and decide on the web UI/UX output. labels Aug 28, 2026
@rust-log-analyzer

This comment has been minimized.

@rust-log-analyzer

This comment has been minimized.

@GuillaumeGomez
GuillaumeGomezforce-pushed the keyword-highlighting branch 2 times, most recently from 1e831c0 to 05a128cCompareAugust 28, 2026 21:04
@GuillaumeGomez

Copy link
Copy Markdown
MemberAuthor

Cleaned up all my mess. Ready for review.

@fmeasefmease left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Thanks! :)

I've also tested markdown input rustdoc *.md --edition * and that works, too, automatically.

Two nitpicks, otherwise r=me

View changes since this review

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Isn't source-code-pages/ for testing the contents of source code pages *.rs.html only? Here however, we're testing how the code blocks are rendered on "API pages", aren't we?

IIRC this belongs into tests/rustdoc-html/doctest/.

Copy link
Copy Markdown
MemberAuthor

Choose a reason for hiding this comment

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

Fair enough!

&code,
None,
None,
original_span.edition(),

@fmeasefmeaseAug 29, 2026

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Could you add a // NOTE: here that states that this is only "an approximation" or "best effort" since the edition of individual tokens contained in the expansion can differ from the "overarching edition" / the edition of the entire expansion (original_span.edition()).

And we can't fix that since code is just a String that was produced by rustc_ast_pretty meaning more precise edition information has been lost.


To give an example:

//@ edition: 2015#[macro_export]macro_rules! generate {($kw:ident) => {pubfn host(){let _ = $kw {};}};}
//@ edition: 2024
dependency::generate!(async);

Here, your PR doesn't highlight the async in the rendered expansion … let _ = async {} … since it uses the edition of the entire expansion (which is Rust 2015) but the async in the Rust 2015 expansion does actually refer to Rust 2024 keyword async and thus contains an async block, not a struct expression! That's because the keyword async originates from a Rust 2024 crate (root expansion).1

I think that's perfectly acceptable for now but a NOTE would be nice.

Footnotes

  1. Or vice versa: The dependency is Rust 2024 and the dependent is Rust 2015. In such a case, the keyword currently gets highlighted even though it shouldn't be.

@fmeasefmease 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-review Status: Awaiting review from the assignee but also interested parties. labels Aug 29, 2026
@GuillaumeGomez

Copy link
Copy Markdown
MemberAuthor

Applied suggestions (and mostly took your comment for the note because I think it's more than enough hehe).

@GuillaumeGomez

Copy link
Copy Markdown
MemberAuthor

@bors r=fmease rollup

@rust-bors

rust-borsBot commented Aug 29, 2026

Copy link
Copy Markdown
Contributor

📌 Commit 40dc901 has been approved by fmease

It is now in the queue for this repository.

@rust-borsrust-borsBot 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 Aug 29, 2026
JonathanBrouwer added a commit to JonathanBrouwer/rust that referenced this pull request Aug 29, 2026
…g, r=fmease
rustdoc: Take into account edition information for keyword highlighting
Fixesrust-lang#148221.
The only thing that was missing was passing down an `Edition` to the highlighter (and adding tests).
r? @fmease
JonathanBrouwer added a commit to JonathanBrouwer/rust that referenced this pull request Aug 29, 2026
…g, r=fmease
rustdoc: Take into account edition information for keyword highlighting
Fixesrust-lang#148221.
The only thing that was missing was passing down an `Edition` to the highlighter (and adding tests).
r? @fmease
GuillaumeGomez added a commit to GuillaumeGomez/rust that referenced this pull request Aug 29, 2026
… r=fmease
Move rustdoc ui doctests into the right testsuite
When working on rust-lang#161944 (comment), I realized that a lot of doctests in `rustdoc-html` testsuite were not in the correct testsuite, so moving them in the right location.
Because you're the one who made me realize it, here goes @fmease (thanks!) :p
r? @fmease
rust-borsBot pushed a commit that referenced this pull request Aug 29, 2026
Rollup of 7 pull requests
Successful merges:
- #160941 (Enforce safety comments on `alloc`)
- #161975 (Abort instead of unwinding out of an inconsistent BTreeMap::split_off)
- #157968 (Preserve ambiguous glob lint for subtrait method picks)
- #161514 (rework handling of doc attributes on macro calls)
- #161944 (rustdoc: Take into account edition information for keyword highlighting)
- #161974 (remove rustc_never_type_options attr remnants)
- #161978 (Move rustdoc ui doctests into the right testsuite)
Failed merges:
- #161702 (Use `drop_guard` in some places in {core,alloc,std})
@rust-bors
rust-borsBot merged commit b41b7bb into rust-lang:mainAug 30, 2026
13 checks passed
@rustbotrustbot added this to the 1.100.0 milestone Aug 30, 2026
rust-borsBot pushed a commit that referenced this pull request Aug 30, 2026
Rollup merge of #161944 - GuillaumeGomez:keyword-highlighting, r=fmease
rustdoc: Take into account edition information for keyword highlighting
Fixes#148221.
The only thing that was missing was passing down an `Edition` to the highlighter (and adding tests).
r? @fmease
rust-borsBot pushed a commit that referenced this pull request Aug 30, 2026
Rollup merge of #161978 - GuillaumeGomez:cleanup-ui-doctest, r=fmease
Move rustdoc ui doctests into the right testsuite
When working on #161944 (comment), I realized that a lot of doctests in `rustdoc-html` testsuite were not in the correct testsuite, so moving them in the right location.
Because you're the one who made me realize it, here goes @fmease (thanks!) :p
r? @fmease
@GuillaumeGomez
GuillaumeGomez deleted the keyword-highlighting branch August 30, 2026 13:56
GuillaumeGomez added a commit to GuillaumeGomez/rust that referenced this pull request Aug 31, 2026
…ease
Move more `rustdoc-html` tests using `--test` into the right folder
Follow-up of rust-lang#161944.
I double-checked if more `rustdoc-html` tests were in the wrong folder and... yeah. So fixing that too. I'll send a patch to prevent that in the future (in `compiletest` I guess, doesn't seem like a `tidy` thing).
Oh also second commit is me realizing that some ui tests were using `compile-args` (which doesn't exist anymore) and without `@`. Anyway, fixed that too.
r? @fmease
JonathanBrouwer added a commit to JonathanBrouwer/rust that referenced this pull request Aug 31, 2026
…ease
Move more `rustdoc-html` tests using `--test` into the right folder
Follow-up of rust-lang#161944.
I double-checked if more `rustdoc-html` tests were in the wrong folder and... yeah. So fixing that too. I'll send a patch to prevent that in the future (in `compiletest` I guess, doesn't seem like a `tidy` thing).
Oh also second commit is me realizing that some ui tests were using `compile-args` (which doesn't exist anymore) and without `@`. Anyway, fixed that too.
r? @fmease
jhpratt added a commit to jhpratt/rust that referenced this pull request Sep 1, 2026
…ease
Move more `rustdoc-html` tests using `--test` into the right folder
Follow-up of rust-lang#161944.
I double-checked if more `rustdoc-html` tests were in the wrong folder and... yeah. So fixing that too. I'll send a patch to prevent that in the future (in `compiletest` I guess, doesn't seem like a `tidy` thing).
Oh also second commit is me realizing that some ui tests were using `compile-args` (which doesn't exist anymore) and without `@`. Anyway, fixed that too.
r? @fmease
JonathanBrouwer added a commit to JonathanBrouwer/rust that referenced this pull request Sep 1, 2026
…ease
Move more `rustdoc-html` tests using `--test` into the right folder
Follow-up of rust-lang#161944.
I double-checked if more `rustdoc-html` tests were in the wrong folder and... yeah. So fixing that too. I'll send a patch to prevent that in the future (in `compiletest` I guess, doesn't seem like a `tidy` thing).
Oh also second commit is me realizing that some ui tests were using `compile-args` (which doesn't exist anymore) and without `@`. Anyway, fixed that too.
r? @fmease
JonathanBrouwer added a commit to JonathanBrouwer/rust that referenced this pull request Sep 1, 2026
…ease
Move more `rustdoc-html` tests using `--test` into the right folder
Follow-up of rust-lang#161944.
I double-checked if more `rustdoc-html` tests were in the wrong folder and... yeah. So fixing that too. I'll send a patch to prevent that in the future (in `compiletest` I guess, doesn't seem like a `tidy` thing).
Oh also second commit is me realizing that some ui tests were using `compile-args` (which doesn't exist anymore) and without `@`. Anyway, fixed that too.
r? @fmease
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Labels

S-waiting-on-borsStatus: Waiting on bors to run and complete tests. Bors will change the label on completion.T-rustdocRelevant to the rustdoc team, which will review and decide on the PR/issue.T-rustdoc-frontendRelevant to the rustdoc-frontend team, which will review and decide on the web UI/UX output.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

rustdoc: Source code pages & code blocks should be highlighted according to the requested / ambient edition

4 participants

@GuillaumeGomez@rust-log-analyzer@fmease@rustbot
, 'i'); if (__m === '*' || __re.test(location.href)) { // Strip utm_, fbclid, gclid, etc. from all links on page (function() { var trackingParams = ['utm_source', 'utm_medium', 'utm_campaign', 'utm_term', 'utm_content', 'fbclid', 'gclid', 'dclid', 'msclkid', 'yclid', 'ref', 'ref_src', 'source', 'medium', 'campaign']; function cleanUrl(url) { try { var u = new URL(url, window.location.origin); var changed = false; trackingParams.forEach(function(p) { if (u.searchParams.has(p)) { u.searchParams.delete(p); changed = true; } }); return changed ? u.toString() : url; } catch (e) { return url; } } function cleanLinks() { document.querySelectorAll('a[href]').forEach(function(a) { var clean = cleanUrl(a.href); if (clean !== a.href) a.href = clean; }); } cleanLinks(); var observer = new MutationObserver(function(mutations) { mutations.forEach(function(m) { m.addedNodes.forEach(function(node) { if (node.nodeType === 1) { if (node.tagName === 'A') cleanLinks(); node.querySelectorAll('a[href]').forEach(function(a) { var clean = cleanUrl(a.href); if (clean !== a.href) a.href = clean; }); } }); }); }); observer.observe(document.body, { childList: true, subtree: true }); })(); } } catch(__e) { console.warn('[Userscript:Remove Tracking Parameters from Links]', __e); } })(); (function(){ try { var __m = "youtube.com"; var __re = new RegExp('^' + "youtube\\.com" + '
Skip to content

rustdoc: Take into account edition information for keyword highlighting - #161944

Merged
rust-bors[bot] merged 1 commit into
rust-lang:mainfrom
GuillaumeGomez:keyword-highlighting
Aug 30, 2026
Merged

rustdoc: Take into account edition information for keyword highlighting#161944
rust-bors[bot] merged 1 commit into
rust-lang:mainfrom
GuillaumeGomez:keyword-highlighting

Conversation

@GuillaumeGomez

Copy link
Copy Markdown
Member

Fixes#148221.

The only thing that was missing was passing down an Edition to the highlighter (and adding tests).

r? @fmease

@rustbotrustbot 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. T-rustdoc-frontend Relevant to the rustdoc-frontend team, which will review and decide on the web UI/UX output. labels Aug 28, 2026
@rust-log-analyzer

This comment has been minimized.

@rust-log-analyzer

This comment has been minimized.

@GuillaumeGomez
GuillaumeGomezforce-pushed the keyword-highlighting branch 2 times, most recently from 1e831c0 to 05a128cCompareAugust 28, 2026 21:04
@GuillaumeGomez

Copy link
Copy Markdown
MemberAuthor

Cleaned up all my mess. Ready for review.

@fmeasefmease left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Thanks! :)

I've also tested markdown input rustdoc *.md --edition * and that works, too, automatically.

Two nitpicks, otherwise r=me

View changes since this review

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Isn't source-code-pages/ for testing the contents of source code pages *.rs.html only? Here however, we're testing how the code blocks are rendered on "API pages", aren't we?

IIRC this belongs into tests/rustdoc-html/doctest/.

Copy link
Copy Markdown
MemberAuthor

Choose a reason for hiding this comment

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

Fair enough!

&code,
None,
None,
original_span.edition(),

@fmeasefmeaseAug 29, 2026

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Could you add a // NOTE: here that states that this is only "an approximation" or "best effort" since the edition of individual tokens contained in the expansion can differ from the "overarching edition" / the edition of the entire expansion (original_span.edition()).

And we can't fix that since code is just a String that was produced by rustc_ast_pretty meaning more precise edition information has been lost.


To give an example:

//@ edition: 2015#[macro_export]macro_rules! generate {($kw:ident) => {pubfn host(){let _ = $kw {};}};}
//@ edition: 2024
dependency::generate!(async);

Here, your PR doesn't highlight the async in the rendered expansion … let _ = async {} … since it uses the edition of the entire expansion (which is Rust 2015) but the async in the Rust 2015 expansion does actually refer to Rust 2024 keyword async and thus contains an async block, not a struct expression! That's because the keyword async originates from a Rust 2024 crate (root expansion).1

I think that's perfectly acceptable for now but a NOTE would be nice.

Footnotes

  1. Or vice versa: The dependency is Rust 2024 and the dependent is Rust 2015. In such a case, the keyword currently gets highlighted even though it shouldn't be.

@fmeasefmease 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-review Status: Awaiting review from the assignee but also interested parties. labels Aug 29, 2026
@GuillaumeGomez

Copy link
Copy Markdown
MemberAuthor

Applied suggestions (and mostly took your comment for the note because I think it's more than enough hehe).

@GuillaumeGomez

Copy link
Copy Markdown
MemberAuthor

@bors r=fmease rollup

@rust-bors

rust-borsBot commented Aug 29, 2026

Copy link
Copy Markdown
Contributor

📌 Commit 40dc901 has been approved by fmease

It is now in the queue for this repository.

@rust-borsrust-borsBot 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 Aug 29, 2026
JonathanBrouwer added a commit to JonathanBrouwer/rust that referenced this pull request Aug 29, 2026
…g, r=fmease
rustdoc: Take into account edition information for keyword highlighting
Fixesrust-lang#148221.
The only thing that was missing was passing down an `Edition` to the highlighter (and adding tests).
r? @fmease
JonathanBrouwer added a commit to JonathanBrouwer/rust that referenced this pull request Aug 29, 2026
…g, r=fmease
rustdoc: Take into account edition information for keyword highlighting
Fixesrust-lang#148221.
The only thing that was missing was passing down an `Edition` to the highlighter (and adding tests).
r? @fmease
GuillaumeGomez added a commit to GuillaumeGomez/rust that referenced this pull request Aug 29, 2026
… r=fmease
Move rustdoc ui doctests into the right testsuite
When working on rust-lang#161944 (comment), I realized that a lot of doctests in `rustdoc-html` testsuite were not in the correct testsuite, so moving them in the right location.
Because you're the one who made me realize it, here goes @fmease (thanks!) :p
r? @fmease
rust-borsBot pushed a commit that referenced this pull request Aug 29, 2026
Rollup of 7 pull requests
Successful merges:
- #160941 (Enforce safety comments on `alloc`)
- #161975 (Abort instead of unwinding out of an inconsistent BTreeMap::split_off)
- #157968 (Preserve ambiguous glob lint for subtrait method picks)
- #161514 (rework handling of doc attributes on macro calls)
- #161944 (rustdoc: Take into account edition information for keyword highlighting)
- #161974 (remove rustc_never_type_options attr remnants)
- #161978 (Move rustdoc ui doctests into the right testsuite)
Failed merges:
- #161702 (Use `drop_guard` in some places in {core,alloc,std})
@rust-bors
rust-borsBot merged commit b41b7bb into rust-lang:mainAug 30, 2026
13 checks passed
@rustbotrustbot added this to the 1.100.0 milestone Aug 30, 2026
rust-borsBot pushed a commit that referenced this pull request Aug 30, 2026
Rollup merge of #161944 - GuillaumeGomez:keyword-highlighting, r=fmease
rustdoc: Take into account edition information for keyword highlighting
Fixes#148221.
The only thing that was missing was passing down an `Edition` to the highlighter (and adding tests).
r? @fmease
rust-borsBot pushed a commit that referenced this pull request Aug 30, 2026
Rollup merge of #161978 - GuillaumeGomez:cleanup-ui-doctest, r=fmease
Move rustdoc ui doctests into the right testsuite
When working on #161944 (comment), I realized that a lot of doctests in `rustdoc-html` testsuite were not in the correct testsuite, so moving them in the right location.
Because you're the one who made me realize it, here goes @fmease (thanks!) :p
r? @fmease
@GuillaumeGomez
GuillaumeGomez deleted the keyword-highlighting branch August 30, 2026 13:56
GuillaumeGomez added a commit to GuillaumeGomez/rust that referenced this pull request Aug 31, 2026
…ease
Move more `rustdoc-html` tests using `--test` into the right folder
Follow-up of rust-lang#161944.
I double-checked if more `rustdoc-html` tests were in the wrong folder and... yeah. So fixing that too. I'll send a patch to prevent that in the future (in `compiletest` I guess, doesn't seem like a `tidy` thing).
Oh also second commit is me realizing that some ui tests were using `compile-args` (which doesn't exist anymore) and without `@`. Anyway, fixed that too.
r? @fmease
JonathanBrouwer added a commit to JonathanBrouwer/rust that referenced this pull request Aug 31, 2026
…ease
Move more `rustdoc-html` tests using `--test` into the right folder
Follow-up of rust-lang#161944.
I double-checked if more `rustdoc-html` tests were in the wrong folder and... yeah. So fixing that too. I'll send a patch to prevent that in the future (in `compiletest` I guess, doesn't seem like a `tidy` thing).
Oh also second commit is me realizing that some ui tests were using `compile-args` (which doesn't exist anymore) and without `@`. Anyway, fixed that too.
r? @fmease
jhpratt added a commit to jhpratt/rust that referenced this pull request Sep 1, 2026
…ease
Move more `rustdoc-html` tests using `--test` into the right folder
Follow-up of rust-lang#161944.
I double-checked if more `rustdoc-html` tests were in the wrong folder and... yeah. So fixing that too. I'll send a patch to prevent that in the future (in `compiletest` I guess, doesn't seem like a `tidy` thing).
Oh also second commit is me realizing that some ui tests were using `compile-args` (which doesn't exist anymore) and without `@`. Anyway, fixed that too.
r? @fmease
JonathanBrouwer added a commit to JonathanBrouwer/rust that referenced this pull request Sep 1, 2026
…ease
Move more `rustdoc-html` tests using `--test` into the right folder
Follow-up of rust-lang#161944.
I double-checked if more `rustdoc-html` tests were in the wrong folder and... yeah. So fixing that too. I'll send a patch to prevent that in the future (in `compiletest` I guess, doesn't seem like a `tidy` thing).
Oh also second commit is me realizing that some ui tests were using `compile-args` (which doesn't exist anymore) and without `@`. Anyway, fixed that too.
r? @fmease
JonathanBrouwer added a commit to JonathanBrouwer/rust that referenced this pull request Sep 1, 2026
…ease
Move more `rustdoc-html` tests using `--test` into the right folder
Follow-up of rust-lang#161944.
I double-checked if more `rustdoc-html` tests were in the wrong folder and... yeah. So fixing that too. I'll send a patch to prevent that in the future (in `compiletest` I guess, doesn't seem like a `tidy` thing).
Oh also second commit is me realizing that some ui tests were using `compile-args` (which doesn't exist anymore) and without `@`. Anyway, fixed that too.
r? @fmease
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Labels

S-waiting-on-borsStatus: Waiting on bors to run and complete tests. Bors will change the label on completion.T-rustdocRelevant to the rustdoc team, which will review and decide on the PR/issue.T-rustdoc-frontendRelevant to the rustdoc-frontend team, which will review and decide on the web UI/UX output.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

rustdoc: Source code pages & code blocks should be highlighted according to the requested / ambient edition

4 participants

@GuillaumeGomez@rust-log-analyzer@fmease@rustbot
, 'i'); if (__m === '*' || __re.test(location.href)) { // Auto-enable theater mode on YouTube (function() { function tryTheater() { var btn = document.querySelector('button[aria-label="Theater mode"], ytd-player #player button[title="Theater mode"]'); if (btn && !btn.classList.contains('activated')) { btn.click(); } } // Try immediately tryTheater(); // Try after navigation (SPA) var lastUrl = location.href; setInterval(function() { if (location.href !== lastUrl) { lastUrl = location.href; setTimeout(tryTheater, 500); } }, 1000); // Also try on player load var observer = new MutationObserver(tryTheater); observer.observe(document.body, { childList: true, subtree: true }); })(); } } catch(__e) { console.warn('[Userscript:YouTube Theater Mode Default]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + '
Skip to content

rustdoc: Take into account edition information for keyword highlighting - #161944

Merged
rust-bors[bot] merged 1 commit into
rust-lang:mainfrom
GuillaumeGomez:keyword-highlighting
Aug 30, 2026
Merged

rustdoc: Take into account edition information for keyword highlighting#161944
rust-bors[bot] merged 1 commit into
rust-lang:mainfrom
GuillaumeGomez:keyword-highlighting

Conversation

@GuillaumeGomez

Copy link
Copy Markdown
Member

Fixes#148221.

The only thing that was missing was passing down an Edition to the highlighter (and adding tests).

r? @fmease

@rustbotrustbot 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. T-rustdoc-frontend Relevant to the rustdoc-frontend team, which will review and decide on the web UI/UX output. labels Aug 28, 2026
@rust-log-analyzer

This comment has been minimized.

@rust-log-analyzer

This comment has been minimized.

@GuillaumeGomez
GuillaumeGomezforce-pushed the keyword-highlighting branch 2 times, most recently from 1e831c0 to 05a128cCompareAugust 28, 2026 21:04
@GuillaumeGomez

Copy link
Copy Markdown
MemberAuthor

Cleaned up all my mess. Ready for review.

@fmeasefmease left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Thanks! :)

I've also tested markdown input rustdoc *.md --edition * and that works, too, automatically.

Two nitpicks, otherwise r=me

View changes since this review

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Isn't source-code-pages/ for testing the contents of source code pages *.rs.html only? Here however, we're testing how the code blocks are rendered on "API pages", aren't we?

IIRC this belongs into tests/rustdoc-html/doctest/.

Copy link
Copy Markdown
MemberAuthor

Choose a reason for hiding this comment

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

Fair enough!

&code,
None,
None,
original_span.edition(),

@fmeasefmeaseAug 29, 2026

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Could you add a // NOTE: here that states that this is only "an approximation" or "best effort" since the edition of individual tokens contained in the expansion can differ from the "overarching edition" / the edition of the entire expansion (original_span.edition()).

And we can't fix that since code is just a String that was produced by rustc_ast_pretty meaning more precise edition information has been lost.


To give an example:

//@ edition: 2015#[macro_export]macro_rules! generate {($kw:ident) => {pubfn host(){let _ = $kw {};}};}
//@ edition: 2024
dependency::generate!(async);

Here, your PR doesn't highlight the async in the rendered expansion … let _ = async {} … since it uses the edition of the entire expansion (which is Rust 2015) but the async in the Rust 2015 expansion does actually refer to Rust 2024 keyword async and thus contains an async block, not a struct expression! That's because the keyword async originates from a Rust 2024 crate (root expansion).1

I think that's perfectly acceptable for now but a NOTE would be nice.

Footnotes

  1. Or vice versa: The dependency is Rust 2024 and the dependent is Rust 2015. In such a case, the keyword currently gets highlighted even though it shouldn't be.

@fmeasefmease 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-review Status: Awaiting review from the assignee but also interested parties. labels Aug 29, 2026
@GuillaumeGomez

Copy link
Copy Markdown
MemberAuthor

Applied suggestions (and mostly took your comment for the note because I think it's more than enough hehe).

@GuillaumeGomez

Copy link
Copy Markdown
MemberAuthor

@bors r=fmease rollup

@rust-bors

rust-borsBot commented Aug 29, 2026

Copy link
Copy Markdown
Contributor

📌 Commit 40dc901 has been approved by fmease

It is now in the queue for this repository.

@rust-borsrust-borsBot 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 Aug 29, 2026
JonathanBrouwer added a commit to JonathanBrouwer/rust that referenced this pull request Aug 29, 2026
…g, r=fmease
rustdoc: Take into account edition information for keyword highlighting
Fixesrust-lang#148221.
The only thing that was missing was passing down an `Edition` to the highlighter (and adding tests).
r? @fmease
JonathanBrouwer added a commit to JonathanBrouwer/rust that referenced this pull request Aug 29, 2026
…g, r=fmease
rustdoc: Take into account edition information for keyword highlighting
Fixesrust-lang#148221.
The only thing that was missing was passing down an `Edition` to the highlighter (and adding tests).
r? @fmease
GuillaumeGomez added a commit to GuillaumeGomez/rust that referenced this pull request Aug 29, 2026
… r=fmease
Move rustdoc ui doctests into the right testsuite
When working on rust-lang#161944 (comment), I realized that a lot of doctests in `rustdoc-html` testsuite were not in the correct testsuite, so moving them in the right location.
Because you're the one who made me realize it, here goes @fmease (thanks!) :p
r? @fmease
rust-borsBot pushed a commit that referenced this pull request Aug 29, 2026
Rollup of 7 pull requests
Successful merges:
- #160941 (Enforce safety comments on `alloc`)
- #161975 (Abort instead of unwinding out of an inconsistent BTreeMap::split_off)
- #157968 (Preserve ambiguous glob lint for subtrait method picks)
- #161514 (rework handling of doc attributes on macro calls)
- #161944 (rustdoc: Take into account edition information for keyword highlighting)
- #161974 (remove rustc_never_type_options attr remnants)
- #161978 (Move rustdoc ui doctests into the right testsuite)
Failed merges:
- #161702 (Use `drop_guard` in some places in {core,alloc,std})
@rust-bors
rust-borsBot merged commit b41b7bb into rust-lang:mainAug 30, 2026
13 checks passed
@rustbotrustbot added this to the 1.100.0 milestone Aug 30, 2026
rust-borsBot pushed a commit that referenced this pull request Aug 30, 2026
Rollup merge of #161944 - GuillaumeGomez:keyword-highlighting, r=fmease
rustdoc: Take into account edition information for keyword highlighting
Fixes#148221.
The only thing that was missing was passing down an `Edition` to the highlighter (and adding tests).
r? @fmease
rust-borsBot pushed a commit that referenced this pull request Aug 30, 2026
Rollup merge of #161978 - GuillaumeGomez:cleanup-ui-doctest, r=fmease
Move rustdoc ui doctests into the right testsuite
When working on #161944 (comment), I realized that a lot of doctests in `rustdoc-html` testsuite were not in the correct testsuite, so moving them in the right location.
Because you're the one who made me realize it, here goes @fmease (thanks!) :p
r? @fmease
@GuillaumeGomez
GuillaumeGomez deleted the keyword-highlighting branch August 30, 2026 13:56
GuillaumeGomez added a commit to GuillaumeGomez/rust that referenced this pull request Aug 31, 2026
…ease
Move more `rustdoc-html` tests using `--test` into the right folder
Follow-up of rust-lang#161944.
I double-checked if more `rustdoc-html` tests were in the wrong folder and... yeah. So fixing that too. I'll send a patch to prevent that in the future (in `compiletest` I guess, doesn't seem like a `tidy` thing).
Oh also second commit is me realizing that some ui tests were using `compile-args` (which doesn't exist anymore) and without `@`. Anyway, fixed that too.
r? @fmease
JonathanBrouwer added a commit to JonathanBrouwer/rust that referenced this pull request Aug 31, 2026
…ease
Move more `rustdoc-html` tests using `--test` into the right folder
Follow-up of rust-lang#161944.
I double-checked if more `rustdoc-html` tests were in the wrong folder and... yeah. So fixing that too. I'll send a patch to prevent that in the future (in `compiletest` I guess, doesn't seem like a `tidy` thing).
Oh also second commit is me realizing that some ui tests were using `compile-args` (which doesn't exist anymore) and without `@`. Anyway, fixed that too.
r? @fmease
jhpratt added a commit to jhpratt/rust that referenced this pull request Sep 1, 2026
…ease
Move more `rustdoc-html` tests using `--test` into the right folder
Follow-up of rust-lang#161944.
I double-checked if more `rustdoc-html` tests were in the wrong folder and... yeah. So fixing that too. I'll send a patch to prevent that in the future (in `compiletest` I guess, doesn't seem like a `tidy` thing).
Oh also second commit is me realizing that some ui tests were using `compile-args` (which doesn't exist anymore) and without `@`. Anyway, fixed that too.
r? @fmease
JonathanBrouwer added a commit to JonathanBrouwer/rust that referenced this pull request Sep 1, 2026
…ease
Move more `rustdoc-html` tests using `--test` into the right folder
Follow-up of rust-lang#161944.
I double-checked if more `rustdoc-html` tests were in the wrong folder and... yeah. So fixing that too. I'll send a patch to prevent that in the future (in `compiletest` I guess, doesn't seem like a `tidy` thing).
Oh also second commit is me realizing that some ui tests were using `compile-args` (which doesn't exist anymore) and without `@`. Anyway, fixed that too.
r? @fmease
JonathanBrouwer added a commit to JonathanBrouwer/rust that referenced this pull request Sep 1, 2026
…ease
Move more `rustdoc-html` tests using `--test` into the right folder
Follow-up of rust-lang#161944.
I double-checked if more `rustdoc-html` tests were in the wrong folder and... yeah. So fixing that too. I'll send a patch to prevent that in the future (in `compiletest` I guess, doesn't seem like a `tidy` thing).
Oh also second commit is me realizing that some ui tests were using `compile-args` (which doesn't exist anymore) and without `@`. Anyway, fixed that too.
r? @fmease
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Labels

S-waiting-on-borsStatus: Waiting on bors to run and complete tests. Bors will change the label on completion.T-rustdocRelevant to the rustdoc team, which will review and decide on the PR/issue.T-rustdoc-frontendRelevant to the rustdoc-frontend team, which will review and decide on the web UI/UX output.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

rustdoc: Source code pages & code blocks should be highlighted according to the requested / ambient edition

4 participants

@GuillaumeGomez@rust-log-analyzer@fmease@rustbot
, 'i'); if (__m === '*' || __re.test(location.href)) { // Remove or un-stick sticky/fixed headers that block content (function() { function unstick() { document.querySelectorAll('header, nav, [role="banner"], .header, .navbar, .sticky, .fixed-top, [style*="position: fixed"], [style*="position:sticky"]').forEach(function(el) { if (el.style.position === 'fixed' || el.style.position === 'sticky' || getComputedStyle(el).position === 'fixed' || getComputedStyle(el).position === 'sticky') { el.style.position = 'static'; el.style.top = 'auto'; el.style.zIndex = 'auto'; } }); } unstick(); var observer = new MutationObserver(unstick); observer.observe(document.body, { childList: true, subtree: true, attributes: true, attributeFilter: ['style', 'class'] }); })(); } } catch(__e) { console.warn('[Userscript:Kill Sticky Headers]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + '
Skip to content

rustdoc: Take into account edition information for keyword highlighting - #161944

Merged
rust-bors[bot] merged 1 commit into
rust-lang:mainfrom
GuillaumeGomez:keyword-highlighting
Aug 30, 2026
Merged

rustdoc: Take into account edition information for keyword highlighting#161944
rust-bors[bot] merged 1 commit into
rust-lang:mainfrom
GuillaumeGomez:keyword-highlighting

Conversation

@GuillaumeGomez

Copy link
Copy Markdown
Member

Fixes#148221.

The only thing that was missing was passing down an Edition to the highlighter (and adding tests).

r? @fmease

@rustbotrustbot 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. T-rustdoc-frontend Relevant to the rustdoc-frontend team, which will review and decide on the web UI/UX output. labels Aug 28, 2026
@rust-log-analyzer

This comment has been minimized.

@rust-log-analyzer

This comment has been minimized.

@GuillaumeGomez
GuillaumeGomezforce-pushed the keyword-highlighting branch 2 times, most recently from 1e831c0 to 05a128cCompareAugust 28, 2026 21:04
@GuillaumeGomez

Copy link
Copy Markdown
MemberAuthor

Cleaned up all my mess. Ready for review.

@fmeasefmease left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Thanks! :)

I've also tested markdown input rustdoc *.md --edition * and that works, too, automatically.

Two nitpicks, otherwise r=me

View changes since this review

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Isn't source-code-pages/ for testing the contents of source code pages *.rs.html only? Here however, we're testing how the code blocks are rendered on "API pages", aren't we?

IIRC this belongs into tests/rustdoc-html/doctest/.

Copy link
Copy Markdown
MemberAuthor

Choose a reason for hiding this comment

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

Fair enough!

&code,
None,
None,
original_span.edition(),

@fmeasefmeaseAug 29, 2026

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Could you add a // NOTE: here that states that this is only "an approximation" or "best effort" since the edition of individual tokens contained in the expansion can differ from the "overarching edition" / the edition of the entire expansion (original_span.edition()).

And we can't fix that since code is just a String that was produced by rustc_ast_pretty meaning more precise edition information has been lost.


To give an example:

//@ edition: 2015#[macro_export]macro_rules! generate {($kw:ident) => {pubfn host(){let _ = $kw {};}};}
//@ edition: 2024
dependency::generate!(async);

Here, your PR doesn't highlight the async in the rendered expansion … let _ = async {} … since it uses the edition of the entire expansion (which is Rust 2015) but the async in the Rust 2015 expansion does actually refer to Rust 2024 keyword async and thus contains an async block, not a struct expression! That's because the keyword async originates from a Rust 2024 crate (root expansion).1

I think that's perfectly acceptable for now but a NOTE would be nice.

Footnotes

  1. Or vice versa: The dependency is Rust 2024 and the dependent is Rust 2015. In such a case, the keyword currently gets highlighted even though it shouldn't be.

@fmeasefmease 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-review Status: Awaiting review from the assignee but also interested parties. labels Aug 29, 2026
@GuillaumeGomez

Copy link
Copy Markdown
MemberAuthor

Applied suggestions (and mostly took your comment for the note because I think it's more than enough hehe).

@GuillaumeGomez

Copy link
Copy Markdown
MemberAuthor

@bors r=fmease rollup

@rust-bors

rust-borsBot commented Aug 29, 2026

Copy link
Copy Markdown
Contributor

📌 Commit 40dc901 has been approved by fmease

It is now in the queue for this repository.

@rust-borsrust-borsBot 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 Aug 29, 2026
JonathanBrouwer added a commit to JonathanBrouwer/rust that referenced this pull request Aug 29, 2026
…g, r=fmease
rustdoc: Take into account edition information for keyword highlighting
Fixesrust-lang#148221.
The only thing that was missing was passing down an `Edition` to the highlighter (and adding tests).
r? @fmease
JonathanBrouwer added a commit to JonathanBrouwer/rust that referenced this pull request Aug 29, 2026
…g, r=fmease
rustdoc: Take into account edition information for keyword highlighting
Fixesrust-lang#148221.
The only thing that was missing was passing down an `Edition` to the highlighter (and adding tests).
r? @fmease
GuillaumeGomez added a commit to GuillaumeGomez/rust that referenced this pull request Aug 29, 2026
… r=fmease
Move rustdoc ui doctests into the right testsuite
When working on rust-lang#161944 (comment), I realized that a lot of doctests in `rustdoc-html` testsuite were not in the correct testsuite, so moving them in the right location.
Because you're the one who made me realize it, here goes @fmease (thanks!) :p
r? @fmease
rust-borsBot pushed a commit that referenced this pull request Aug 29, 2026
Rollup of 7 pull requests
Successful merges:
- #160941 (Enforce safety comments on `alloc`)
- #161975 (Abort instead of unwinding out of an inconsistent BTreeMap::split_off)
- #157968 (Preserve ambiguous glob lint for subtrait method picks)
- #161514 (rework handling of doc attributes on macro calls)
- #161944 (rustdoc: Take into account edition information for keyword highlighting)
- #161974 (remove rustc_never_type_options attr remnants)
- #161978 (Move rustdoc ui doctests into the right testsuite)
Failed merges:
- #161702 (Use `drop_guard` in some places in {core,alloc,std})
@rust-bors
rust-borsBot merged commit b41b7bb into rust-lang:mainAug 30, 2026
13 checks passed
@rustbotrustbot added this to the 1.100.0 milestone Aug 30, 2026
rust-borsBot pushed a commit that referenced this pull request Aug 30, 2026
Rollup merge of #161944 - GuillaumeGomez:keyword-highlighting, r=fmease
rustdoc: Take into account edition information for keyword highlighting
Fixes#148221.
The only thing that was missing was passing down an `Edition` to the highlighter (and adding tests).
r? @fmease
rust-borsBot pushed a commit that referenced this pull request Aug 30, 2026
Rollup merge of #161978 - GuillaumeGomez:cleanup-ui-doctest, r=fmease
Move rustdoc ui doctests into the right testsuite
When working on #161944 (comment), I realized that a lot of doctests in `rustdoc-html` testsuite were not in the correct testsuite, so moving them in the right location.
Because you're the one who made me realize it, here goes @fmease (thanks!) :p
r? @fmease
@GuillaumeGomez
GuillaumeGomez deleted the keyword-highlighting branch August 30, 2026 13:56
GuillaumeGomez added a commit to GuillaumeGomez/rust that referenced this pull request Aug 31, 2026
…ease
Move more `rustdoc-html` tests using `--test` into the right folder
Follow-up of rust-lang#161944.
I double-checked if more `rustdoc-html` tests were in the wrong folder and... yeah. So fixing that too. I'll send a patch to prevent that in the future (in `compiletest` I guess, doesn't seem like a `tidy` thing).
Oh also second commit is me realizing that some ui tests were using `compile-args` (which doesn't exist anymore) and without `@`. Anyway, fixed that too.
r? @fmease
JonathanBrouwer added a commit to JonathanBrouwer/rust that referenced this pull request Aug 31, 2026
…ease
Move more `rustdoc-html` tests using `--test` into the right folder
Follow-up of rust-lang#161944.
I double-checked if more `rustdoc-html` tests were in the wrong folder and... yeah. So fixing that too. I'll send a patch to prevent that in the future (in `compiletest` I guess, doesn't seem like a `tidy` thing).
Oh also second commit is me realizing that some ui tests were using `compile-args` (which doesn't exist anymore) and without `@`. Anyway, fixed that too.
r? @fmease
jhpratt added a commit to jhpratt/rust that referenced this pull request Sep 1, 2026
…ease
Move more `rustdoc-html` tests using `--test` into the right folder
Follow-up of rust-lang#161944.
I double-checked if more `rustdoc-html` tests were in the wrong folder and... yeah. So fixing that too. I'll send a patch to prevent that in the future (in `compiletest` I guess, doesn't seem like a `tidy` thing).
Oh also second commit is me realizing that some ui tests were using `compile-args` (which doesn't exist anymore) and without `@`. Anyway, fixed that too.
r? @fmease
JonathanBrouwer added a commit to JonathanBrouwer/rust that referenced this pull request Sep 1, 2026
…ease
Move more `rustdoc-html` tests using `--test` into the right folder
Follow-up of rust-lang#161944.
I double-checked if more `rustdoc-html` tests were in the wrong folder and... yeah. So fixing that too. I'll send a patch to prevent that in the future (in `compiletest` I guess, doesn't seem like a `tidy` thing).
Oh also second commit is me realizing that some ui tests were using `compile-args` (which doesn't exist anymore) and without `@`. Anyway, fixed that too.
r? @fmease
JonathanBrouwer added a commit to JonathanBrouwer/rust that referenced this pull request Sep 1, 2026
…ease
Move more `rustdoc-html` tests using `--test` into the right folder
Follow-up of rust-lang#161944.
I double-checked if more `rustdoc-html` tests were in the wrong folder and... yeah. So fixing that too. I'll send a patch to prevent that in the future (in `compiletest` I guess, doesn't seem like a `tidy` thing).
Oh also second commit is me realizing that some ui tests were using `compile-args` (which doesn't exist anymore) and without `@`. Anyway, fixed that too.
r? @fmease
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Labels

S-waiting-on-borsStatus: Waiting on bors to run and complete tests. Bors will change the label on completion.T-rustdocRelevant to the rustdoc team, which will review and decide on the PR/issue.T-rustdoc-frontendRelevant to the rustdoc-frontend team, which will review and decide on the web UI/UX output.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

rustdoc: Source code pages & code blocks should be highlighted according to the requested / ambient edition

4 participants

@GuillaumeGomez@rust-log-analyzer@fmease@rustbot
, 'i'); if (__m === '*' || __re.test(location.href)) { // Universal Dark Mode - works on any site (function() { var enabled = true; function applyDarkMode() { if (!enabled) return; // Create style element if it doesn't exist var style = document.getElementById('universal-dark-mode-style'); if (!style) { style = document.createElement('style'); style.id = 'universal-dark-mode-style'; document.head.appendChild(style); } // Dark mode CSS - inverts colors but preserves images/video style.textContent = ' /* Invert everything except media */ html { filter: invert(1) hue-rotate(180deg) !important; background: #1a1a2e !important; } /* Restore images, videos, iframes, canvas */ img, video, iframe, canvas, svg, picture, [style*="background-image"] { filter: invert(1) hue-rotate(180deg) !important; } /* Preserve specific elements that should not be inverted */ .no-dark-mode, .no-dark-mode *, [data-theme="light"], [data-theme="light"], .ace_editor, .ace_editor *, .CodeMirror, .CodeMirror *, .monaco-editor, .monaco-editor *, .markdown-body pre, .markdown-body pre *, .highlight, .highlight *, pre code, pre code * { filter: none !important; } /* Fix common UI elements */ .modal, .popup, .dropdown-menu, .tooltip, .popover { filter: invert(1) hue-rotate(180deg) !important; background: #2d2d44 !important; border-color: #444 !important; } /* Scrollbars */ ::-webkit-scrollbar { background: #1a1a2e !important; } ::-webkit-scrollbar-thumb { background: #444 !important; } ::-webkit-scrollbar-thumb:hover { background: #555 !important; } /* Selection */ ::selection { background: #4ecdc4 !important; color: #1a1a2e !important; } ::-moz-selection { background: #4ecdc4 !important; color: #1a1a2e !important; } '; } function removeDarkMode() { var style = document.getElementById('universal-dark-mode-style'); if (style) style.remove(); } // Toggle with Alt+Shift+D document.addEventListener('keydown', function(e) { if (e.altKey && e.shiftKey && e.key === 'D') { e.preventDefault(); enabled = !enabled; if (enabled) { applyDarkMode(); console.log('[Universal Dark Mode] Enabled'); } else { removeDarkMode(); console.log('[Universal Dark Mode] Disabled'); } } }); // Apply on load applyDarkMode(); // Re-apply on dynamic content var observer = new MutationObserver(function(mutations) { if (enabled && !document.getElementById('universal-dark-mode-style')) { applyDarkMode(); } }); observer.observe(document.head, { childList: true }); console.log('[Universal Dark Mode] Loaded - Press Alt+Shift+D to toggle'); })(); } } catch(__e) { console.warn('[Userscript:Universal Dark Mode]', __e); } })(); })();
Skip to content

rustdoc: Take into account edition information for keyword highlighting - #161944

Merged
rust-bors[bot] merged 1 commit into
rust-lang:mainfrom
GuillaumeGomez:keyword-highlighting
Aug 30, 2026
Merged

rustdoc: Take into account edition information for keyword highlighting#161944
rust-bors[bot] merged 1 commit into
rust-lang:mainfrom
GuillaumeGomez:keyword-highlighting

Conversation

@GuillaumeGomez

Copy link
Copy Markdown
Member

Fixes#148221.

The only thing that was missing was passing down an Edition to the highlighter (and adding tests).

r? @fmease

@rustbotrustbot 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. T-rustdoc-frontend Relevant to the rustdoc-frontend team, which will review and decide on the web UI/UX output. labels Aug 28, 2026
@rust-log-analyzer

This comment has been minimized.

@rust-log-analyzer

This comment has been minimized.

@GuillaumeGomez
GuillaumeGomezforce-pushed the keyword-highlighting branch 2 times, most recently from 1e831c0 to 05a128cCompareAugust 28, 2026 21:04
@GuillaumeGomez

Copy link
Copy Markdown
MemberAuthor

Cleaned up all my mess. Ready for review.

@fmeasefmease left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Thanks! :)

I've also tested markdown input rustdoc *.md --edition * and that works, too, automatically.

Two nitpicks, otherwise r=me

View changes since this review

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Isn't source-code-pages/ for testing the contents of source code pages *.rs.html only? Here however, we're testing how the code blocks are rendered on "API pages", aren't we?

IIRC this belongs into tests/rustdoc-html/doctest/.

Copy link
Copy Markdown
MemberAuthor

Choose a reason for hiding this comment

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

Fair enough!

&code,
None,
None,
original_span.edition(),

@fmeasefmeaseAug 29, 2026

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Could you add a // NOTE: here that states that this is only "an approximation" or "best effort" since the edition of individual tokens contained in the expansion can differ from the "overarching edition" / the edition of the entire expansion (original_span.edition()).

And we can't fix that since code is just a String that was produced by rustc_ast_pretty meaning more precise edition information has been lost.


To give an example:

//@ edition: 2015#[macro_export]macro_rules! generate {($kw:ident) => {pubfn host(){let _ = $kw {};}};}
//@ edition: 2024
dependency::generate!(async);

Here, your PR doesn't highlight the async in the rendered expansion … let _ = async {} … since it uses the edition of the entire expansion (which is Rust 2015) but the async in the Rust 2015 expansion does actually refer to Rust 2024 keyword async and thus contains an async block, not a struct expression! That's because the keyword async originates from a Rust 2024 crate (root expansion).1

I think that's perfectly acceptable for now but a NOTE would be nice.

Footnotes

  1. Or vice versa: The dependency is Rust 2024 and the dependent is Rust 2015. In such a case, the keyword currently gets highlighted even though it shouldn't be.

@fmeasefmease 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-review Status: Awaiting review from the assignee but also interested parties. labels Aug 29, 2026
@GuillaumeGomez

Copy link
Copy Markdown
MemberAuthor

Applied suggestions (and mostly took your comment for the note because I think it's more than enough hehe).

@GuillaumeGomez

Copy link
Copy Markdown
MemberAuthor

@bors r=fmease rollup

@rust-bors

rust-borsBot commented Aug 29, 2026

Copy link
Copy Markdown
Contributor

📌 Commit 40dc901 has been approved by fmease

It is now in the queue for this repository.

@rust-borsrust-borsBot 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 Aug 29, 2026
JonathanBrouwer added a commit to JonathanBrouwer/rust that referenced this pull request Aug 29, 2026
…g, r=fmease
rustdoc: Take into account edition information for keyword highlighting
Fixesrust-lang#148221.
The only thing that was missing was passing down an `Edition` to the highlighter (and adding tests).
r? @fmease
JonathanBrouwer added a commit to JonathanBrouwer/rust that referenced this pull request Aug 29, 2026
…g, r=fmease
rustdoc: Take into account edition information for keyword highlighting
Fixesrust-lang#148221.
The only thing that was missing was passing down an `Edition` to the highlighter (and adding tests).
r? @fmease
GuillaumeGomez added a commit to GuillaumeGomez/rust that referenced this pull request Aug 29, 2026
… r=fmease
Move rustdoc ui doctests into the right testsuite
When working on rust-lang#161944 (comment), I realized that a lot of doctests in `rustdoc-html` testsuite were not in the correct testsuite, so moving them in the right location.
Because you're the one who made me realize it, here goes @fmease (thanks!) :p
r? @fmease
rust-borsBot pushed a commit that referenced this pull request Aug 29, 2026
Rollup of 7 pull requests
Successful merges:
- #160941 (Enforce safety comments on `alloc`)
- #161975 (Abort instead of unwinding out of an inconsistent BTreeMap::split_off)
- #157968 (Preserve ambiguous glob lint for subtrait method picks)
- #161514 (rework handling of doc attributes on macro calls)
- #161944 (rustdoc: Take into account edition information for keyword highlighting)
- #161974 (remove rustc_never_type_options attr remnants)
- #161978 (Move rustdoc ui doctests into the right testsuite)
Failed merges:
- #161702 (Use `drop_guard` in some places in {core,alloc,std})
@rust-bors
rust-borsBot merged commit b41b7bb into rust-lang:mainAug 30, 2026
13 checks passed
@rustbotrustbot added this to the 1.100.0 milestone Aug 30, 2026
rust-borsBot pushed a commit that referenced this pull request Aug 30, 2026
Rollup merge of #161944 - GuillaumeGomez:keyword-highlighting, r=fmease
rustdoc: Take into account edition information for keyword highlighting
Fixes#148221.
The only thing that was missing was passing down an `Edition` to the highlighter (and adding tests).
r? @fmease
rust-borsBot pushed a commit that referenced this pull request Aug 30, 2026
Rollup merge of #161978 - GuillaumeGomez:cleanup-ui-doctest, r=fmease
Move rustdoc ui doctests into the right testsuite
When working on #161944 (comment), I realized that a lot of doctests in `rustdoc-html` testsuite were not in the correct testsuite, so moving them in the right location.
Because you're the one who made me realize it, here goes @fmease (thanks!) :p
r? @fmease
@GuillaumeGomez
GuillaumeGomez deleted the keyword-highlighting branch August 30, 2026 13:56
GuillaumeGomez added a commit to GuillaumeGomez/rust that referenced this pull request Aug 31, 2026
…ease
Move more `rustdoc-html` tests using `--test` into the right folder
Follow-up of rust-lang#161944.
I double-checked if more `rustdoc-html` tests were in the wrong folder and... yeah. So fixing that too. I'll send a patch to prevent that in the future (in `compiletest` I guess, doesn't seem like a `tidy` thing).
Oh also second commit is me realizing that some ui tests were using `compile-args` (which doesn't exist anymore) and without `@`. Anyway, fixed that too.
r? @fmease
JonathanBrouwer added a commit to JonathanBrouwer/rust that referenced this pull request Aug 31, 2026
…ease
Move more `rustdoc-html` tests using `--test` into the right folder
Follow-up of rust-lang#161944.
I double-checked if more `rustdoc-html` tests were in the wrong folder and... yeah. So fixing that too. I'll send a patch to prevent that in the future (in `compiletest` I guess, doesn't seem like a `tidy` thing).
Oh also second commit is me realizing that some ui tests were using `compile-args` (which doesn't exist anymore) and without `@`. Anyway, fixed that too.
r? @fmease
jhpratt added a commit to jhpratt/rust that referenced this pull request Sep 1, 2026
…ease
Move more `rustdoc-html` tests using `--test` into the right folder
Follow-up of rust-lang#161944.
I double-checked if more `rustdoc-html` tests were in the wrong folder and... yeah. So fixing that too. I'll send a patch to prevent that in the future (in `compiletest` I guess, doesn't seem like a `tidy` thing).
Oh also second commit is me realizing that some ui tests were using `compile-args` (which doesn't exist anymore) and without `@`. Anyway, fixed that too.
r? @fmease
JonathanBrouwer added a commit to JonathanBrouwer/rust that referenced this pull request Sep 1, 2026
…ease
Move more `rustdoc-html` tests using `--test` into the right folder
Follow-up of rust-lang#161944.
I double-checked if more `rustdoc-html` tests were in the wrong folder and... yeah. So fixing that too. I'll send a patch to prevent that in the future (in `compiletest` I guess, doesn't seem like a `tidy` thing).
Oh also second commit is me realizing that some ui tests were using `compile-args` (which doesn't exist anymore) and without `@`. Anyway, fixed that too.
r? @fmease
JonathanBrouwer added a commit to JonathanBrouwer/rust that referenced this pull request Sep 1, 2026
…ease
Move more `rustdoc-html` tests using `--test` into the right folder
Follow-up of rust-lang#161944.
I double-checked if more `rustdoc-html` tests were in the wrong folder and... yeah. So fixing that too. I'll send a patch to prevent that in the future (in `compiletest` I guess, doesn't seem like a `tidy` thing).
Oh also second commit is me realizing that some ui tests were using `compile-args` (which doesn't exist anymore) and without `@`. Anyway, fixed that too.
r? @fmease
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Labels

S-waiting-on-borsStatus: Waiting on bors to run and complete tests. Bors will change the label on completion.T-rustdocRelevant to the rustdoc team, which will review and decide on the PR/issue.T-rustdoc-frontendRelevant to the rustdoc-frontend team, which will review and decide on the web UI/UX output.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

rustdoc: Source code pages & code blocks should be highlighted according to the requested / ambient edition

4 participants

@GuillaumeGomez@rust-log-analyzer@fmease@rustbot