rustdoc: notable trait badge color attribute - #160370

notriddle · 2026-08-02T06:54:02Z

Part of #45040

Screenshots

rustbot · 2026-08-02T06:54:06Z

Some changes occurred in GUI tests.

cc @GuillaumeGomez

Some changes occurred in HTML/CSS/JS.

cc @GuillaumeGomez, @lolbinarycat

Some changes occurred in compiler/rustc_attr_parsing

cc @jdonszelmann, @JonathanBrouwer

Some changes occurred in compiler/rustc_hir/src/attrs

cc @jdonszelmann, @JonathanBrouwer

rustbot · 2026-08-02T06:54:07Z

r? @petrochenkov

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

Use r? to explicitly pick a reviewer

Why was this reviewer chosen?

The reviewer was selected based on:

Owners of files modified in this PR: compiler
compiler expanded to 75 candidates
Random selection from 18 candidates

GuillaumeGomez · 2026-08-02T10:33:43Z

-	--notable-badge-pink: oklch(0.88 0.21 0);
-	--notable-badge-red: oklch(0.88 0.21 40);
-	--notable-badge-orange: oklch(0.88 0.21 70);
+	--notable-badge-grey: oklch(0.88 0 0);


We're now switching to 8 colors?

View changes since the review

I can’t find it in the meeting minutes, but I remember mentioning the possibility of using the ANSI 3-bit color pallet, because it makes both directions of interop easier:

terminal apps like rusty-man can display these colors without requiring their own bespoke color theming system

anyone adding new themes to rustdoc-html can easily use a terminal color theme as a starting point

GuillaumeGomez · 2026-08-02T10:38:47Z

+        {% if !notable_trait_badges.is_empty() %}
+        <div class="notable-trait-badge-container">
+            {% for badge in notable_trait_badges.iter() %}
+            <a class="notable-trait-badge notable-trait-badge-{{badge.color}}"


I feel like this is duplicating information: the parent is already the unique class notable-trait-badge-container and the badge itself already has the notable-trait-badge class, so having notable-trait-badge- seems too much (also maybe we should remove the notable-trait-badge class). What about just keeping the color?

View changes since the review

Oh also, please indent. Makes it simpler to read the template.

GuillaumeGomez · 2026-08-02T11:33:29Z

+one of the other colors in the list:
+
+<style>
+  .notabletrait-badge {


Why changing the appearance of the badge?

View changes since the review

I wanted the text inside the badge to be aligned with the code block below it.

GuillaumeGomez · 2026-08-02T11:33:59Z

+    border-radius: 6px;
+    padding: 8px;
+  }
+  .notabletrait-badge.light {


Same: why changing the color property?

View changes since the review

GuillaumeGomez · 2026-08-02T11:34:44Z

+    border-color: #0f1419;
+  }
+  /* https://github.com/rust-lang/rust/pull/91480 */
+  .notabletrait-badge.light.grey {


I'm really not sure it's worth it to show people how to add their own colors.

View changes since the review

GuillaumeGomez · 2026-08-02T11:35:12Z

-	padding: 0 0.5rem;
-	border-radius: 0.75rem;
+	padding: 0 14px;
+	border-radius: var(--code-block-border-radius);


Why this change?

View changes since the review

It’s the same padding and border radius as code blocks.

GuillaumeGomez · 2026-08-02T11:36:59Z

-	--notable-badge-violet: oklch(0.88 0.21 300);
+	--notable-badge-magenta: oklch(0.88 0.21 320);
+	--notable-badge-cyan: oklch(0.88 0.21 180);
+	--notable-badge-transparent: white;


I don't think having text floating around is a good idea, especially when it's a color picked by rustdoc automatically...

View changes since the review

petrochenkov · 2026-08-02T11:45:11Z

r? @GuillaumeGomez

Co-authored-by: Guillaume Gomez <contact@guillaume-gomez.fr>

rust-log-analyzer · 2026-08-02T16:42:38Z

The job aarch64-gnu-llvm-21-1 failed! Check out the build log: (web) (plain enhanced) (plain)

Click to see the possible cause of the failure (guessed by this bot)

   Compiling rustc_next_trait_solver v0.0.0 (/checkout/compiler/rustc_next_trait_solver)
[RUSTC-TIMING] rustc_next_trait_solver test:false 2.032
[RUSTC-TIMING] rustc_target test:false 12.134
   Compiling rustc_hir v0.0.0 (/checkout/compiler/rustc_hir)
error[E0277]: the trait bound `&str: From<&NotableTraitColor>` is not satisfied
   --> compiler/rustc_hir/src/attrs/data_structures.rs:647:26
    |
647 |         f.write_str(self.into())
    |                          ^^^^ the trait `From<&NotableTraitColor>` is not implemented for `&str`
    |
    = note: required for `&NotableTraitColor` to implement `Into<&str>`
help: consider dereferencing here
    |
647 |         f.write_str((*self).into())
    |                     ++    +

For more information about this error, try `rustc --explain E0277`.
[RUSTC-TIMING] rustc_hir test:false 1.706
error: could not compile `rustc_hir` (lib) due to 1 previous error
Bootstrap failed while executing `--stage 2 test --skip tidy --skip intrinsic-test --skip compiler --skip src`

ThierryBerger · 2026-08-03T06:48:09Z

+    Transparent,
+}
+
+impl Into<&'static str> for NotableTraitColor {


Should we prefer From ?

Also, should we consider having the opposite direction ? Simplifying the parsing code and grouping similar behaviour in here.

View changes since the review

ThierryBerger · 2026-08-03T06:48:51Z

-    /// Determines whether an item is annotated with `#[doc(notable_trait)]`.
-    query is_doc_notable_trait(def_id: DefId) -> bool {
+    /// If an item is annotated with `#[doc(notable_trait)]`,
+    /// returns the color used to render its pill. If the crate specifies


Is it a pill or a badge ? We should have consistent naming

View changes since the review

rustdoc: notable trait badge color attribute

48d9203

rustbot assigned petrochenkov Aug 2, 2026

notriddle removed T-rustdoc Relevant to the rustdoc team, which will review and decide on the PR/issue. T-compiler Relevant to the compiler team, which will review and decide on the PR/issue. T-libs Relevant to the library team, which will review and decide on the PR/issue. labels Aug 2, 2026

GuillaumeGomez reviewed Aug 2, 2026

View reviewed changes

Comment thread compiler/rustc_hir/src/attrs/data_structures.rs Outdated

GuillaumeGomez reviewed Aug 2, 2026

View reviewed changes

rustbot assigned GuillaumeGomez and unassigned petrochenkov Aug 2, 2026

Update compiler/rustc_hir/src/attrs/data_structures.rs

3e4974b

Co-authored-by: Guillaume Gomez <contact@guillaume-gomez.fr>

ThierryBerger reviewed Aug 3, 2026

View reviewed changes

Uh oh!

Uh oh!

Conversation

notriddle commented Aug 2, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Screenshots

Uh oh!

rustbot commented Aug 2, 2026

Uh oh!

rustbot commented Aug 2, 2026

Uh oh!

GuillaumeGomez Aug 2, 2026 • edited by rustbot Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

notriddle Aug 2, 2026

Choose a reason for hiding this comment

Uh oh!

Uh oh!

GuillaumeGomez Aug 2, 2026 • edited by rustbot Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

GuillaumeGomez Aug 2, 2026

Choose a reason for hiding this comment

Uh oh!

GuillaumeGomez Aug 2, 2026 • edited by rustbot Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

notriddle Aug 2, 2026

Choose a reason for hiding this comment

Uh oh!

GuillaumeGomez Aug 2, 2026 • edited by rustbot Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

GuillaumeGomez Aug 2, 2026 • edited by rustbot Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

GuillaumeGomez Aug 2, 2026 • edited by rustbot Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

notriddle Aug 2, 2026

Choose a reason for hiding this comment

Uh oh!

GuillaumeGomez Aug 2, 2026 • edited by rustbot Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

petrochenkov commented Aug 2, 2026

Uh oh!

rust-log-analyzer commented Aug 2, 2026

Uh oh!

ThierryBerger Aug 3, 2026 • edited by rustbot Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

ThierryBerger Aug 3, 2026 • edited by rustbot Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

6 participants

notriddle commented Aug 2, 2026 •

edited

Loading

GuillaumeGomez Aug 2, 2026 •

edited by rustbot

Loading

GuillaumeGomez Aug 2, 2026 •

edited by rustbot

Loading

GuillaumeGomez Aug 2, 2026 •

edited by rustbot

Loading

GuillaumeGomez Aug 2, 2026 •

edited by rustbot

Loading

GuillaumeGomez Aug 2, 2026 •

edited by rustbot

Loading

GuillaumeGomez Aug 2, 2026 •

edited by rustbot

Loading

GuillaumeGomez Aug 2, 2026 •

edited by rustbot

Loading

ThierryBerger Aug 3, 2026 •

edited by rustbot

Loading

ThierryBerger Aug 3, 2026 •

edited by rustbot

Loading