-
Notifications
You must be signed in to change notification settings - Fork 12.9k
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
Conversation
@rust-lang/docs |
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
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. |
This looks great @QuietMisdreavus! :) @bors r=frewsxcxv, GuillaumeGomez |
📌 Commit bfd01b7 has been approved by |
🔒 Merge conflict |
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. |
Nah. This is a homu issue. You can remove the merge commit I'd you want. We'll need to restart bors |
@bors r=frewsxcxv,GuillaumeGomez |
📌 Commit 8dd4c44 has been approved by |
⌛ Testing commit 8dd4c44 with merge d616f47... |
…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
☀️ Test successful - status-appveyor, status-travis |
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:
fixes #41025 and #40687
r? @rust-lang/docs