Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

rustdoc: use docblock class more precisely #92974

Closed
jsha opened this issue Jan 16, 2022 · 0 comments · Fixed by #106828
Closed

rustdoc: use docblock class more precisely #92974

jsha opened this issue Jan 16, 2022 · 0 comments · Fixed by #106828
Labels
A-rustdoc-ui Area: Rustdoc UI (generated HTML) T-rustdoc Relevant to the rustdoc team, which will review and decide on the PR/issue.

Comments

@jsha
Copy link
Contributor

jsha commented Jan 16, 2022

In Rustdoc's CSS, the docblock class generally applies to "Markdown-generated HTML that came from the user." However, right now it's also used in a few other places: the item-decl uses it, and the "All Items" page uses it. This makes maintaining the CSS more complicated, because changes that are expected to affect only one type of node actually affect many.

We should remove the docblock class from item-decl and anywhere else that isn't Markdown-generated documentation, and adjust styles as needed.
@jsha jsha added T-rustdoc Relevant to the rustdoc team, which will review and decide on the PR/issue. A-rustdoc-ui Area: Rustdoc UI (generated HTML) labels Jan 16, 2022
@notriddle notriddle mentioned this issue Jan 13, 2023
Merged
matthiaskrgr added a commit to matthiaskrgr/rust that referenced this issue Jan 14, 2023
@matthiaskrgr
Rollup merge of rust-lang#106828 - notriddle:notriddle/notable-trait-…
14fbc21 
…docblock, r=GuillaumeGomez

rustdoc: remove `docblock` class from notable trait popover

This commit builds on b72de9b, which removes the `docblock` class from the All Items page, and 9457380, which removes the `docblock` class from the item decl.

Fixes rust-lang#92974
@bors bors closed this as completed in 5314ed5 Jan 15, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
A-rustdoc-ui Area: Rustdoc UI (generated HTML) T-rustdoc Relevant to the rustdoc team, which will review and decide on the PR/issue.
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

rustdoc: remove docblock class from notable trait popover notriddle/rust
1 participant
@jsha