Fix documentation header sizes by jsha · Pull Request #90186 · rust-lang/rust

jsha · 2021-10-22T22:53:31Z

And add a rustdoc-gui test confirming various header sizes.

Split off from #90156. This fixes a regression in #89506 where the heading level of titles within Markdown was too high (h2) for docblocks under structs, unions, and enum impls.

r? @camelid

Demo: https://jacob.hoffman-andrews.com/rust/fix-header-sizes/std/string/struct.String.html#impl-Add%3C%26%27_%20str%3E
Stable: https://doc.rust-lang.org/stable/std/string/struct.String.html#impl-Add%3C%26%27_%20str%3E
Beta: https://doc.rust-lang.org/beta/std/string/struct.String.html#impl-Add%3C%26%27_%20str%3E

camelid · 2021-10-23T20:16:33Z

r? @GuillaumeGomez since I'm a bit limited on review time. That way this moves faster :)

Also, Guillaume's our resident rustdoc-gui expert ;)

camelid · 2021-10-23T20:17:31Z

cc @rust-lang/rustdoc for beta backport. This fixes an annoying UI regression present on beta. (See the links at the top comment.)

GuillaumeGomez · 2021-10-25T09:32:25Z

Thanks!

@bors: r+

bors · 2021-10-25T09:32:26Z

📌 Commit b7a948d has been approved by GuillaumeGomez

…omez Fix documentation header sizes And add a rustdoc-gui test confirming various header sizes. Split off from rust-lang#90156. This fixes a regression in rust-lang#89506 where the heading level of titles within Markdown was too high (h2) for docblocks under structs, unions, and enum impls. r? `@camelid` Demo: https://jacob.hoffman-andrews.com/rust/fix-header-sizes/std/string/struct.String.html#impl-Add%3C%26%27_%20str%3E Stable: https://doc.rust-lang.org/stable/std/string/struct.String.html#impl-Add%3C%26%27_%20str%3E Beta: https://doc.rust-lang.org/beta/std/string/struct.String.html#impl-Add%3C%26%27_%20str%3E

…omez Fix documentation header sizes And add a rustdoc-gui test confirming various header sizes. Split off from rust-lang#90156. This fixes a regression in rust-lang#89506 where the heading level of titles within Markdown was too high (h2) for docblocks under structs, unions, and enum impls. r? ``@camelid`` Demo: https://jacob.hoffman-andrews.com/rust/fix-header-sizes/std/string/struct.String.html#impl-Add%3C%26%27_%20str%3E Stable: https://doc.rust-lang.org/stable/std/string/struct.String.html#impl-Add%3C%26%27_%20str%3E Beta: https://doc.rust-lang.org/beta/std/string/struct.String.html#impl-Add%3C%26%27_%20str%3E

matthiaskrgr · 2021-10-25T18:24:01Z

I think this caused the rollup failure but not 100% sure
#90276 (comment)
@bors r-

src/test/rustdoc-gui/header-size.goml

And add a rustdoc-gui test confirming various header sizes.

GuillaumeGomez · 2021-10-26T08:38:51Z

Let's go again!

@bors: r+

bors · 2021-10-26T11:04:57Z

⌛ Testing commit 89276ff with merge bb9b3d84ccdf07dceb5f5877e2ecf6d32a84833e...

bors · 2021-10-26T11:07:43Z

💔 Test failed - checks-actions

rust-log-analyzer · 2021-10-26T11:33:54Z

A job failed! Check out the build log: (web) (plain)

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

jsha · 2021-10-26T17:26:39Z

I believe the build failure is because CI is unhealthy right now.

matthiaskrgr · 2021-10-26T18:31:21Z

@bors retry

…omez Fix documentation header sizes And add a rustdoc-gui test confirming various header sizes. Split off from rust-lang#90156. This fixes a regression in rust-lang#89506 where the heading level of titles within Markdown was too high (h2) for docblocks under structs, unions, and enum impls. r? `@camelid` Demo: https://jacob.hoffman-andrews.com/rust/fix-header-sizes/std/string/struct.String.html#impl-Add%3C%26%27_%20str%3E Stable: https://doc.rust-lang.org/stable/std/string/struct.String.html#impl-Add%3C%26%27_%20str%3E Beta: https://doc.rust-lang.org/beta/std/string/struct.String.html#impl-Add%3C%26%27_%20str%3E

bors · 2021-10-27T12:27:51Z

⌛ Testing commit 89276ff with merge 337e156...

bors · 2021-10-27T15:32:36Z

☀️ Test successful - checks-actions
Approved by: GuillaumeGomez
Pushing 337e156 to master...

rust-timer · 2021-10-27T17:04:34Z

Finished benchmarking commit (337e156): comparison url.

Summary: This benchmark run did not return any relevant changes.

If you disagree with this performance assessment, please file an issue in rust-lang/rustc-perf.

@rustbot label: -perf-regression

apiraino · 2021-10-28T14:13:53Z

Beta backport accepted as per compiler team on Zulip

@rustbot label +beta-accepted

[beta] backports - Fix assertion failures in OwnedHandle with windows_subsystem. rust-lang#88798 - Ensure that pushing empty path works as before on verbatim paths rust-lang#89665 - Feature gate + make must_not_suspend allow-by-default rust-lang#89826 - Only use clone3 when needed for pidfd rust-lang#89930 - Fix documentation header sizes rust-lang#90186 - Fixes incorrect handling of ADT's drop requirements rust-lang#90218 - Fix ICE when forgetting to Box a parameter to a Self::func call rust-lang#90221 - Prevent duplicate caller bounds candidates by exposing default substs in Unevaluated rust-lang#90266 - Update odht crate to 0.3.1 (big-endian bugfix) rust-lang#90403 - rustdoc: Go back to loading all external crates unconditionally rust-lang#90489 - Split doc_cfg and doc_auto_cfg features rust-lang#90502 - Apply adjustments for field expression even if inaccessible rust-lang#90508 - Warn for variables that are no longer captured rust-lang#90597 - Properly register text_direction_codepoint_in_comment lint. rust-lang#90626 - CI: Use ubuntu image to download openssl, curl sources, cacert.pem for x86 dist builds rust-lang#90457 - Android is not GNU rust-lang#90834 - Update llvm submodule rust-lang#90954 Additionally, this bumps the stage 0 compiler from beta to stable 1.56.1. r? `@Mark-Simulacrum`

rust-highfive assigned camelid Oct 22, 2021

rust-highfive added the S-waiting-on-review Status: Awaiting review from the assignee but also interested parties. label Oct 22, 2021

jsha mentioned this pull request Oct 22, 2021

Remove underlines from non-top docblocks. #90156

Merged

This comment has been minimized.

Sign in to view

jsha force-pushed the fix-header-sizes branch from dfcaa6a to b7a948d Compare October 22, 2021 23:46

rust-highfive assigned GuillaumeGomez and unassigned camelid Oct 23, 2021

camelid added beta-nominated Nominated for backporting to the compiler in the beta channel. T-rustdoc Relevant to the rustdoc team, which will review and decide on the PR/issue. labels Oct 23, 2021

jsha mentioned this pull request Oct 24, 2021

Improve display of enum variants #90089

Merged

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 Oct 25, 2021

GuillaumeGomez mentioned this pull request Oct 25, 2021

Rollup of 5 pull requests #90264

Closed

matthiaskrgr mentioned this pull request Oct 25, 2021

Rollup of 4 pull requests #90276

Closed

bors added S-waiting-on-author Status: This is awaiting some action (such as code changes or more information) from the author. and removed S-waiting-on-bors Status: Waiting on bors to run and complete tests. Bors will change the label on completion. labels Oct 25, 2021

camelid reviewed Oct 25, 2021

View reviewed changes

src/test/rustdoc-gui/header-size.goml Outdated Show resolved Hide resolved

Fix documentation header sizes

89276ff

And add a rustdoc-gui test confirming various header sizes.

jsha force-pushed the fix-header-sizes branch from b7a948d to 89276ff Compare October 25, 2021 23:31

camelid added S-waiting-on-review Status: Awaiting review from the assignee but also interested parties. and removed S-waiting-on-author Status: This is awaiting some action (such as code changes or more information) from the author. labels Oct 26, 2021

bors added S-waiting-on-review Status: Awaiting review from the assignee but also interested parties. and removed S-waiting-on-bors Status: Waiting on bors to run and complete tests. Bors will change the label on completion. labels Oct 26, 2021

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 Oct 26, 2021

matthiaskrgr mentioned this pull request Oct 26, 2021

Rollup of 4 pull requests #90325

Closed

bors added the merged-by-bors This PR was explicitly merged by bors. label Oct 27, 2021

bors merged commit 337e156 into rust-lang:master Oct 27, 2021

rustbot added this to the 1.58.0 milestone Oct 27, 2021

jsha deleted the fix-header-sizes branch October 27, 2021 17:47

rustbot added the beta-accepted Accepted for backporting to the compiler in the beta channel. label Oct 28, 2021

cuviper mentioned this pull request Nov 16, 2021

[beta] backports #90938

Merged

cuviper removed the beta-nominated Nominated for backporting to the compiler in the beta channel. label Nov 16, 2021

cuviper modified the milestones: 1.58.0, 1.57.0 Nov 16, 2021

Uh oh!

Conversation

jsha commented Oct 22, 2021 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

This comment has been minimized.

camelid commented Oct 23, 2021

Uh oh!

camelid commented Oct 23, 2021

Uh oh!

GuillaumeGomez commented Oct 25, 2021

Uh oh!

bors commented Oct 25, 2021

Uh oh!

matthiaskrgr commented Oct 25, 2021

Uh oh!

Uh oh!

GuillaumeGomez commented Oct 26, 2021

Uh oh!

bors commented Oct 26, 2021

Uh oh!

bors commented Oct 26, 2021

Uh oh!

rust-log-analyzer commented Oct 26, 2021

Uh oh!

jsha commented Oct 26, 2021

Uh oh!

matthiaskrgr commented Oct 26, 2021

Uh oh!

bors commented Oct 27, 2021

Uh oh!

bors commented Oct 27, 2021

Uh oh!

rust-timer commented Oct 27, 2021

Uh oh!

apiraino commented Oct 28, 2021

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

11 participants

jsha commented Oct 22, 2021 •

edited

Loading