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

Fix headings indent #91223

Merged
merged 2 commits into from
Nov 27, 2021
Merged

Fix headings indent #91223

merged 2 commits into from
Nov 27, 2021

Conversation

GuillaumeGomez
Copy link
Member

@GuillaumeGomez GuillaumeGomez commented Nov 25, 2021 •
edited
Loading

Fixes #91200.

Screenshots with the fix:

Screenshot from 2021-11-25 15-32-35
Screenshot from 2021-11-25 15-32-49

If the first element of a top docblock is a heading, we still need to keep the indent, but only on this one (I added a test to check it). We need it because otherwise the anchor will go over the [-] toggle.

cc @camelid
r? @jsha

@GuillaumeGomez GuillaumeGomez 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 Nov 25, 2021
@rust-highfive
Copy link
Collaborator

Some changes occurred in HTML/CSS/JS.

cc @GuillaumeGomez

@rust-highfive rust-highfive added the S-waiting-on-review Status: Awaiting review from the assignee but also interested parties. label Nov 25, 2021
jsha
jsha reviewed Nov 25, 2021
View reviewed changes
Copy link
Contributor

@jsha jsha left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nice, thanks for fixing this - it had been bugging me too and I never got around to filing an issue. :-)

@bors r+ rollup

@camelid
Copy link
Member

camelid commented Nov 25, 2021

The first commit comes from #91181 to make things easier.

Wait, we shouldn't be landing both of these PRs at the same time. I'm unapproving for now, please re-approve once the other PR has landed and you've rebased over master.

@bors r-

@bors 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-review Status: Awaiting review from the assignee but also interested parties. labels Nov 25, 2021
@camelid
Copy link
Member

camelid commented Nov 25, 2021

Also, @jsha looks like bors ignores commands in reviews?

@camelid
Copy link
Member

camelid commented Nov 25, 2021

The first commit comes from #91181 to make things easier.

And please remove this line once you've rebased too.

@GuillaumeGomez
Copy link
Member Author

Rebased on master so #91181 is now included and removed from the commit list. :)

@bors: r=jsha rollup

@bors
Copy link
Contributor

bors commented Nov 26, 2021

📌 Commit 2342756 has been approved by jsha

@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-author Status: This is awaiting some action (such as code changes or more information) from the author. labels Nov 26, 2021
@matthiaskrgr matthiaskrgr mentioned this pull request Nov 26, 2021
Merged
bors added a commit to rust-lang-ci/rust that referenced this pull request Nov 27, 2021
@bors
Auto merge of rust-lang#91269 - matthiaskrgr:rollup-jh8i8eh, r=matthi…
bbad745 
…askrgr

Rollup of 7 pull requests

Successful merges:

 - rust-lang#90611 (Fix another ICE in rustdoc scrape_examples)
 - rust-lang#91197 (rustdoc: Rename `Type::ResolvedPath` to `Type::Path` and don't re-export it)
 - rust-lang#91223 (Fix headings indent)
 - rust-lang#91240 (Saner formatting for UTF8_CHAR_WIDTH table)
 - rust-lang#91248 (Bump compiler-builtins to 0.1.53)
 - rust-lang#91252 (Fix bug where submodules wouldn't be updated when running x.py from a subdirectory)
 - rust-lang#91259 (Remove `--display-doctest-warnings`)

Failed merges:

r? `@ghost`
`@rustbot` modify labels: rollup
@bors bors merged commit 330a558 into rust-lang:master Nov 27, 2021
@rustbot rustbot added this to the 1.58.0 milestone Nov 27, 2021
@GuillaumeGomez GuillaumeGomez deleted the headings-indent branch November 27, 2021 10:39
@camelid camelid mentioned this pull request Nov 28, 2021
Closed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@jsha jsha jsha approved these changes

Assignees

@jsha jsha

Labels
A-rustdoc-ui Area: Rustdoc UI (generated HTML) S-waiting-on-bors Status: Waiting on bors to run and complete tests. Bors will change the label on completion. T-rustdoc Relevant to the rustdoc team, which will review and decide on the PR/issue.
Projects
None yet
Milestone
1.58.0
Development

Successfully merging this pull request may close these issues.

The first heading in all doc comments have left margin
6 participants
@GuillaumeGomez @rust-highfive @camelid @bors @jsha @rustbot