Rustdoc label badge for notable traits

[ThierryBerger]

View all comments

• Part of Tracking Issue for doc_label_trait #156865
• reuse notable trait feature to feed badge data
• render it in html
• add some html tests
• Render a color from a hash from its full path
• fixed oklch hue-driven palette checked against wcag/apca

Should the following be out of scope ?

• Parse color (#[doc(notable_trait(color="0xff0000")])
• display a small colored indicator (with a hover/first letter?) when a type implementing a notable trait is listed outside of its main page
• Some Integration with rust analyzer

Color discussion

I went for the higher chroma, even though some values use a fallback, I'm not opposed to go for a less chromatic palette, but that's very bikeshedding so I'll defer to authority.

with chroma 0.21:

with chroma 0.090:

History

Initially, this PR added a new feature "label_trait", it was then decided in rustdoc meeting to reuse current notable_trait feature.

[rustbot]

Some changes occurred in compiler/rustc_attr_parsing

cc @jdonszelmann, @JonathanBrouwer

Some changes occurred in compiler/rustc_passes/src/check_attr.rs

cc @jdonszelmann, @JonathanBrouwer

Some changes occurred in HTML/CSS/JS.

cc @GuillaumeGomez, @lolbinarycat

rust-analyzer is developed in its own repository. If possible, consider making this change to rust-lang/rust-analyzer instead.

cc @rust-lang/rust-analyzer

Some changes occurred in compiler/rustc_hir/src/attrs

cc @jdonszelmann, @JonathanBrouwer

[rustbot]

r? @fmease

rustbot has assigned @fmease.
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: rustdoc
• rustdoc expanded to 9 candidates
• Random selection from GuillaumeGomez, camelid, fmease, lolbinarycat, notriddle

[GuillaumeGomez]

Render a color from a hash from DefId -> ⚠️ is that an issue? color won't be stable between releases.

I would generated the color hash from the trait path (so crate::Trait for current crate, etc). Like that it will be stable across releases.

[GuillaumeGomez]

Instead of using a Vec, would be better to use a BTreeMap. It's sorted on insert and prevents duplications.

View changes since the review

[ThierryBerger]

I changed to do that but then collect it to Vec, keeping this discussion opened as I'm not sure if you meant something else.

[Veykril]

Could you remove the two rust-analyzer changes please? They don't do anything as is so they will likely cause unnecessary conflicts for us

View changes since this review

[rustbot]

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.

[GuillaumeGomez]

With my changes, it now looks like this:

The text color is the same as the main one, so I changed the badges color a bit to match with it.

@ThierryBerger: I don't think we'll allow to set any color we want (because of theme things), only one between the 6 we provide. If it's fine with you, let's do that in a follow-up.

[ThierryBerger]

Nice, thanks @GuillaumeGomez ; your changes look good to me, I agree with restricting users to the provided set of colors as a follow up.

[GuillaumeGomez]

Let's do it like this then. Thanks a lot for your work. Let's approve this. :)

@bors r+ rollup

[rust-bors]

📌 Commit 493ed4a has been approved by GuillaumeGomez

It is now in the queue for this repository.