rustdoc: notable trait badge and popover enhancements by notriddle · Pull Request #160370 · rust-lang/rust

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

View all comments

Part of #45040

Preview

https://notriddle.com/rustdoc-html-demo-13/gui-tests/lib2/notable_trait_colors/struct.NotableTraitColors.html

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: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.

Do we need it to be the same?

I wanted the text inside the badge to line up with the text in the code block, because it was almost aligned already.

I’m less picky about the border radius, but I made it the same because I was worried about hitting psychovisual weirdness that makes the text look misaligned even if the ruler says it’s perfect.

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

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

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

rustbot · 2026-09-19T02:42:07Z

Some changes occurred in compiler/rustc_attr_ir

cc @jdonszelmann, @JonathanBrouwer

rustbot · 2026-09-19T02:42:09Z

This PR was rebased onto a different main commit. Here's a range-diff highlighting what actually changed.

Rebasing is a normal part of keeping PRs up to date, so no action is needed—this note is just to help reviewers.

Add test cases, and the same detailed info block that you get for return position notable traits.

notriddle · 2026-09-19T02:51:00Z

@GuillaumeGomez @ThierryBerger

I've done some tweaks to take into account feedback from these discussions, plus a few things I noticed while looking around the standard library:

The popover is now part of the notable traits row. If the notable trait is only implemented for certain generics, or if it has an associated type, you can see it in there. Also, it says "Notable traits" inside the popup, so there's at least something that tells you where this list comes from.
The padding and border radius is returned to what the original version used. The left edge of the notable trait badges are aligned with the left edge of the top-doc.
The "transparent" color badges now have a border, so they aren't just floating text with nothing around them.
The colored badges aren't in the docs any more. Just a list of color names.
Formatting fixes: added missing indent to the template, use From instead of Into for the conversion, and using "badge" consistently.

This still produces the feature gate error, so it's fine, but it also produces the "trait attribute" warning

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

Comment thread src/doc/rustdoc/src/unstable-features.md Outdated

GuillaumeGomez reviewed Aug 2, 2026

View reviewed changes

rustbot assigned GuillaumeGomez and unassigned petrochenkov Aug 2, 2026

This comment has been minimized.

Sign in to view

ThierryBerger reviewed Aug 3, 2026

View reviewed changes

This comment has been minimized.

Sign in to view

madsmtm mentioned this pull request Sep 12, 2026

rustdoc: Tracking issue for #[doc(notable_trait)] #45040

Open

2 tasks

notriddle changed the title ~~rustdoc: notable trait badge color attribute~~ rustdoc: notable trait badge and popover enhancements Sep 19, 2026

notriddle and others added 4 commits September 18, 2026 19:27

rustdoc: notable trait badge color attribute

0477367

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

136b399

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

Remove unnecessary repetition and indent

025f6d2

Give transparent badge a visible border

cba5899

notriddle force-pushed the notable-trait-color branch from 3e4974b to ad71924 Compare September 19, 2026 02:42

This comment has been minimized.

Sign in to view

Clean up and enhance notable trait badges

17ce955

Add test cases, and the same detailed info block that you get for return position notable traits.

notriddle force-pushed the notable-trait-color branch from ad71924 to 17ce955 Compare September 19, 2026 02:51

This comment has been minimized.

Sign in to view

notriddle added 2 commits September 18, 2026 20:35

Fix feature gate test case

f0cf8b0

This still produces the feature gate error, so it's fine, but it also produces the "trait attribute" warning

Fix tests

03fbe38

Uh oh!

Conversation

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

Uh oh!

Preview

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!

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 3, 2026

Choose a reason for hiding this comment

Uh oh!

notriddle Aug 3, 2026 • edited 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!

petrochenkov commented Aug 2, 2026

Uh oh!

This comment has been minimized.

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!

This comment has been minimized.

rustbot commented Sep 19, 2026

Uh oh!

rustbot commented Sep 19, 2026

Uh oh!

This comment has been minimized.

notriddle commented Sep 19, 2026

Uh oh!

This comment has been minimized.

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

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

notriddle Aug 3, 2026 •

edited

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