Skip to content

Toggle-wrap items differently than top-doc. #85280

New issue

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

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

Already on GitHub? # to your account

Merged
merged 2 commits into from
May 18, 2021

Conversation

jsha
Copy link
Contributor

@jsha jsha commented May 14, 2021

This makes sure things like trait methods get wrapped at the
<h3><code> level rather than at the .docblock level. Also it ensures
that only the actual top documentation gets the .top-doc class.

Fixes #85167

Before:

image

https://doc.rust-lang.org/nightly/std/io/trait.Read.html#tymethod.read

After:

image

This makes sure things like trait methods get wrapped at the
`<h3><code>` level rather than at the `.docblock` level. Also it ensures
that only the actual top documentation gets the `.top-doc` class.
@rust-highfive rust-highfive added the S-waiting-on-review Status: Awaiting review from the assignee but also interested parties. label May 14, 2021
@GuillaumeGomez
Copy link
Member

Thanks!

@bors: r+

@bors
Copy link
Collaborator

bors commented May 17, 2021

📌 Commit 6696a60 has been approved by GuillaumeGomez

@bors bors 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-review Status: Awaiting review from the assignee but also interested parties. labels May 17, 2021
GuillaumeGomez added a commit to GuillaumeGomez/rust that referenced this pull request May 18, 2021
…eGomez

Toggle-wrap items differently than top-doc.

This makes sure things like trait methods get wrapped at the
`<h3><code>` level rather than at the `.docblock` level. Also it ensures
that only the actual top documentation gets the `.top-doc` class.

Fixes rust-lang#85167

Before:

![image](https://user-images.githubusercontent.com/220205/117743384-98790200-b1bb-11eb-8804-588530842514.png)

https://doc.rust-lang.org/nightly/std/io/trait.Read.html#tymethod.read

After:

![image](https://user-images.githubusercontent.com/220205/118410882-98a75080-b646-11eb-949d-ca688bab6923.png)
bors added a commit to rust-lang-ci/rust that referenced this pull request May 18, 2021
…laumeGomez

Rollup of 7 pull requests

Successful merges:

 - rust-lang#84587 (rustdoc: Make "rust code block is empty" and "could not parse code block" warnings a lint (`INVALID_RUST_CODEBLOCKS`))
 - rust-lang#85280 (Toggle-wrap items differently than top-doc.)
 - rust-lang#85338 (Implement more Iterator methods on core::iter::Repeat)
 - rust-lang#85339 (Report an error if a lang item has the wrong number of generic arguments)
 - rust-lang#85369 (Suggest borrowing if a trait implementation is found for &/&mut <type>)
 - rust-lang#85393 (Suppress spurious errors inside `async fn`)
 - rust-lang#85415 (Clean up remnants of BorrowOfPackedField)

Failed merges:

r? `@ghost`
`@rustbot` modify labels: rollup
@bors bors merged commit d151ed8 into rust-lang:master May 18, 2021
@rustbot rustbot added this to the 1.54.0 milestone May 18, 2021
@jsha jsha deleted the move-trait-toggles branch May 18, 2021 17:47
# for free to join this conversation on GitHub. Already have an account? # to comment
Labels
S-waiting-on-bors Status: Waiting on bors to run and complete tests. Bors will change the label on completion.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

rustdoc: toggles for trait methods are in wrong position
5 participants