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.

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

rustdoc: update formatting of fn signatures and where clauses to match style rfcs #41084

Merged
merged 9 commits into from
Apr 9, 2017

Conversation

QuietMisdreavus
Copy link
Member

@QuietMisdreavus QuietMisdreavus commented Apr 5, 2017

Recent updates to style RFCs (where clauses, function definitions) changed the "canonical" style for these items, so this is a rustdoc update to make it emit that style where necessary. This is mainly a conversion from visual indent to block indent, which helps out in situations where there was excessive indent causing lines to wrap regardless.

Samples:

std::iter::IntoIterator

excerpt from std::iter::Iterator

std::iter::FromIterator

std::cmp::min

some trait impls on std::collections::HashMap

fn extract_code_blocks, an example given in #40687

excerpt from itertools::Itertools

fixes #41025 and #40687

r? @rust-lang/docs

@steveklabnik
Copy link
Member

@rust-lang/docs

@GuillaumeGomez
Copy link
Member

Good for me. Thanks!

- add spaces to output so stripping lines and breaking spaces renders
  the same
- add commas to where clauses in rustdoc tests to match the new output
...so that we don't indent the next line by one extra space
@QuietMisdreavus
Copy link
Member Author

Okay, i think i have both passing tests and proper formatting this time.

If you want to browse a full rendering of std with this, i've got that hosted here, at least while this PR is open. Some other examples, including some crates i picked out specifically to render with this, are available as well, again, at least while this PR is open. If you find some rendering weirdness (at least with where clauses and fn signatures), let me know.

@frewsxcv
Copy link
Member

frewsxcv commented Apr 9, 2017

This looks great @QuietMisdreavus! :)

@bors r=frewsxcxv, GuillaumeGomez

@bors
Copy link
Contributor

bors commented Apr 9, 2017

📌 Commit bfd01b7 has been approved by frewsxcxv,

@bors
Copy link
Contributor

bors commented Apr 9, 2017

🔒 Merge conflict

@QuietMisdreavus
Copy link
Member Author

QuietMisdreavus commented Apr 9, 2017

Oh dear. Do i need to try merging this with a fresh master to see what it's talking about?

EDIT: Oh, i see it now, it was done before the hoedown/pulldown switch.

@frewsxcv
Copy link
Member

frewsxcv commented Apr 9, 2017

Nah. This is a homu issue. You can remove the merge commit I'd you want. We'll need to restart bors

@frewsxcv
Copy link
Member

frewsxcv commented Apr 9, 2017

@bors r=frewsxcxv,GuillaumeGomez

@bors
Copy link
Contributor

bors commented Apr 9, 2017

📌 Commit 8dd4c44 has been approved by frewsxcxv,GuillaumeGomez

@bors
Copy link
Contributor

bors commented Apr 9, 2017

⌛ Testing commit 8dd4c44 with merge d616f47...

bors added a commit that referenced this pull request Apr 9, 2017
…cxv,GuillaumeGomez

rustdoc: update formatting of fn signatures and where clauses to match style rfcs

Recent updates to style RFCs ([where clauses](rust-lang/style-team#38), [function definitions](rust-lang/style-team#39)) changed the "canonical" style for these items, so this is a rustdoc update to make it emit that style where necessary. This is mainly a conversion from visual indent to block indent, which helps out in situations where there was excessive indent causing lines to wrap regardless.

Samples:

![std::iter::IntoIterator](https://cloud.githubusercontent.com/assets/5217170/24712947/e586604c-19e9-11e7-87ae-4fe64d689dc3.png)

![excerpt from std::iter::Iterator](https://cloud.githubusercontent.com/assets/5217170/24713209/91e65112-19ea-11e7-9ff8-d4cf6b31aae1.png)

![std::iter::FromIterator](https://cloud.githubusercontent.com/assets/5217170/24713138/59f36114-19ea-11e7-9dbb-5f5ba7126e2e.png)

![std::cmp::min](https://cloud.githubusercontent.com/assets/5217170/24713038/1bab88b4-19ea-11e7-935d-defed5648de4.png)

![some trait impls on std::collections::HashMap](https://cloud.githubusercontent.com/assets/5217170/24713251/b7ef69e8-19ea-11e7-94a7-e01fbf89fa31.png)

![`fn extract_code_blocks`, an example given in #40687](https://cloud.githubusercontent.com/assets/5217170/24713159/672717cc-19ea-11e7-9acb-6ac278b90339.png)

![excerpt from itertools::Itertools](https://cloud.githubusercontent.com/assets/5217170/24713323/f06716ea-19ea-11e7-94cc-6ef68d9980ec.png)

fixes #41025 and #40687

r? @rust-lang/docs
@bors
Copy link
Contributor

bors commented Apr 9, 2017

☀️ Test successful - status-appveyor, status-travis
Approved by: frewsxcxv,GuillaumeGomez
Pushing d616f47 to master...

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Rustdoc: odd wrapping in code blocks
5 participants