bjoernager/rust
bjoernager/rust
1
Fork 0
Code Activity

Rollup merge of #102447 - notriddle:notriddle/method-toggle, r=jsha

Browse source 
rustdoc: add method spacing to trait methods

More cleanup for 8846c0853d, this time in trait layouts when things are collapsed.

This PR makes two changes to the appearance of trait pages:

* It adds the `method-toggle` class to method toggles on traits, making the DOM more consistent with type pages (which already have this class).

  ## Before

  ![image](https://user-images.githubusercontent.com/1593513/192914353-ed17e1eb-df1d-480b-9998-3b5e8283b0ee.png)

  ## After

  ![image](https://user-images.githubusercontent.com/1593513/192914570-bdd0f2e1-5254-4e2e-9576-a797b82b3b3b.png)

* It adds a bottom margin to docblocks nested directly in the implementors list, giving it a similar appearance to if it was nested within a toggle.

  ## Before

  ![image](https://user-images.githubusercontent.com/1593513/192914503-1c3f39d5-690f-44ec-8f11-385302477d04.png)

  ## After

  ![image](https://user-images.githubusercontent.com/1593513/192914702-cbce4b3b-5cc6-49dc-b7f8-73be9e76791c.png)
This commit is contained in:
Michael Howell 2022-09-29 10:15:19 -07:00 • committed by GitHub
commit 8a73397a62
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
3 changed files with 9 additions and 8 deletions
Download patch file Download diff file Expand all files Collapse all files

2
src/librustdoc/html/render/print_item.rs
View file

@ -716,7 +716,7 @@ fn item_trait(w: &mut Buffer, cx: &mut Context<'_>, it: &clean::Item, t: &clean:
document(&mut content, cx, m, Some(t), HeadingOffset::H5); document(&mut content, cx, m, Some(t), HeadingOffset::H5);
let toggled = !content.is_empty(); let toggled = !content.is_empty();
if toggled { if toggled {
write!(w, "<details class=\"rustdoc-toggle\" open><summary>"); write!(w, "<details class=\"rustdoc-toggle method-toggle\" open><summary>");
} }
write!(w, "<div id=\"{}\" class=\"method has-srclink\">", id); write!(w, "<div id=\"{}\" class=\"method has-srclink\">", id);
render_rightside(w, cx, m, t, RenderMode::Normal); render_rightside(w, cx, m, t, RenderMode::Normal);

3
src/librustdoc/html/static/css/rustdoc.css
View file

@ -2014,7 +2014,8 @@ in storage.js plus the media query with (min-width: 701px)
.method-toggle summary, .method-toggle summary,
.implementors-toggle summary, .implementors-toggle summary,
.impl { .impl,
#implementors-list > .docblock {
margin-bottom: 0.75em; margin-bottom: 0.75em;
} }

12
src/test/rustdoc/toggle-trait-fn.rs
View file

@ -4,12 +4,12 @@
// summary. Trait methods with no documentation should not be wrapped. // summary. Trait methods with no documentation should not be wrapped.
// //
// @has foo/trait.Foo.html // @has foo/trait.Foo.html
// @has - '//details[@class="rustdoc-toggle"]//summary//h4[@class="code-header"]' 'is_documented()' // @has - '//details[@class="rustdoc-toggle method-toggle"]//summary//h4[@class="code-header"]' 'is_documented()'
// @!has - '//details[@class="rustdoc-toggle"]//summary//h4[@class="code-header"]' 'not_documented()' // @!has - '//details[@class="rustdoc-toggle method-toggle"]//summary//h4[@class="code-header"]' 'not_documented()'
// @has - '//details[@class="rustdoc-toggle"]//*[@class="docblock"]' 'is_documented is documented' // @has - '//details[@class="rustdoc-toggle method-toggle"]//*[@class="docblock"]' 'is_documented is documented'
// @has - '//details[@class="rustdoc-toggle"]//summary//h4[@class="code-header"]' 'is_documented_optional()' // @has - '//details[@class="rustdoc-toggle method-toggle"]//summary//h4[@class="code-header"]' 'is_documented_optional()'
// @!has - '//details[@class="rustdoc-toggle"]//summary//h4[@class="code-header"]' 'not_documented_optional()' // @!has - '//details[@class="rustdoc-toggle method-toggle"]//summary//h4[@class="code-header"]' 'not_documented_optional()'
// @has - '//details[@class="rustdoc-toggle"]//*[@class="docblock"]' 'is_documented_optional is documented' // @has - '//details[@class="rustdoc-toggle method-toggle"]//*[@class="docblock"]' 'is_documented_optional is documented'
pub trait Foo { pub trait Foo {
fn not_documented(); fn not_documented();