Skip to content

Commit 71a147d

Browse files
rol1510rol1510
committed
rustdoc: trait bound formatting
rustdoc: fix item-spacer rustdoc: use proper comment style rustdoc: change formatting where clauses for traits rustdoc: remove semicolon from provided methods update provided methods formatting
1 parent 4aa6afa commit 71a147d

11 files changed

+65
-22
lines changed

‎src/librustdoc/html/format.rs

+10-2
Original file line numberDiff line numberDiff line change
@@ -353,7 +353,11 @@ pub(crate) fn print_where_clause<'a, 'tcx: 'a>(
353353
} else {
354354
let mut br_with_padding = String::with_capacity(6 * indent + 28);
355355
br_with_padding.push_str("<br>");
356-
for _ in 0..indent + 4 {
356+
357+
let padding_amout =
358+
if ending == Ending::Newline { indent + 4 } else { indent + "fn where ".len() };
359+
360+
for _ in 0..padding_amout {
357361
br_with_padding.push_str(" ");
358362
}
359363
let where_preds = where_preds.to_string().replace("<br>", &br_with_padding);
@@ -367,8 +371,12 @@ pub(crate) fn print_where_clause<'a, 'tcx: 'a>(
367371
if indent == 0 {
368372
format!("<br><span class=\"where\">where{where_preds}</span>")
369373
} else {
374+
// put the first one on the same line as the 'where' keyword
375+
let where_preds = where_preds.replacen(&br_with_padding, " ", 1);
376+
370377
let mut clause = br_with_padding;
371-
clause.truncate(clause.len() - 4);
378+
clause.truncate(clause.len() - "where ".len());
379+
372380
write!(clause, "<span class=\"where\">where{where_preds}</span>")?;
373381
clause
374382
}

‎src/librustdoc/html/render/print_item.rs

+10-10
Original file line numberDiff line numberDiff line change
@@ -645,6 +645,10 @@ fn item_trait(w: &mut Buffer, cx: &mut Context<'_>, it: &clean::Item, t: &clean:
645645
if count_consts != 0 && count_methods != 0 {
646646
w.write_str("\n");
647647
}
648+
649+
if !required_methods.is_empty() {
650+
write!(w, " // Required method{}\n", pluralize(required_methods.len()));
651+
}
648652
for (pos, m) in required_methods.iter().enumerate() {
649653
render_assoc_item(
650654
w,
@@ -663,6 +667,10 @@ fn item_trait(w: &mut Buffer, cx: &mut Context<'_>, it: &clean::Item, t: &clean:
663667
if !required_methods.is_empty() && !provided_methods.is_empty() {
664668
w.write_str("\n");
665669
}
670+
671+
if !provided_methods.is_empty() {
672+
write!(w, " // Provided method{}\n", pluralize(provided_methods.len()));
673+
}
666674
for (pos, m) in provided_methods.iter().enumerate() {
667675
render_assoc_item(
668676
w,
@@ -672,16 +680,8 @@ fn item_trait(w: &mut Buffer, cx: &mut Context<'_>, it: &clean::Item, t: &clean:
672680
cx,
673681
RenderMode::Normal,
674682
);
675-
match *m.kind {
676-
clean::MethodItem(ref inner, _)
677-
if !inner.generics.where_predicates.is_empty() =>
678-
{
679-
w.write_str(",\n { ... }\n");
680-
}
681-
_ => {
682-
w.write_str(" { ... }\n");
683-
}
684-
}
683+
684+
w.write_str(" { ... }\n");
685685

686686
if pos < provided_methods.len() - 1 {
687687
w.write_str("<span class=\"item-spacer\"></span>");

‎src/librustdoc/html/static/css/rustdoc.css

+1
Original file line numberDiff line numberDiff line change
@@ -1176,6 +1176,7 @@ a.test-arrow:hover {
11761176
.item-spacer {
11771177
width: 100%;
11781178
height: 12px;
1179+
display: block;
11791180
}
11801181

11811182
.out-of-band > span.since {

‎tests/rustdoc/auxiliary/inline-default-methods.rs

+12
Original file line numberDiff line numberDiff line change
@@ -4,3 +4,15 @@ pub trait Foo {
44
fn bar(&self);
55
fn foo(&mut self) {}
66
}
7+
8+
pub trait Bar {
9+
fn bar(&self);
10+
fn foo1(&mut self) {}
11+
fn foo2(&mut self) {}
12+
}
13+
14+
pub trait Baz {
15+
fn bar1(&self);
16+
fn bar2(&self);
17+
fn foo(&mut self) {}
18+
}

‎tests/rustdoc/decl-trailing-whitespace.declaration.html

+3-1
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,9 @@
11
<code>pub trait Write {
2+
// Required methods
23
fn <a href="#tymethod.poll_write" class="fn">poll_write</a>(<br />&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;self: <a class="enum" href="{{channel}}/core/option/enum.Option.html" title="enum core::option::Option">Option</a>&lt;<a class="struct" href="{{channel}}/alloc/string/struct.String.html" title="struct alloc::string::String">String</a>&gt;,<br />&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;cx: &amp;mut <a class="enum" href="{{channel}}/core/option/enum.Option.html" title="enum core::option::Option">Option</a>&lt;<a class="struct" href="{{channel}}/alloc/string/struct.String.html" title="struct alloc::string::String">String</a>&gt;,<br />&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;buf: &amp;mut [<a class="primitive" href="{{channel}}/std/primitive.usize.html">usize</a>]<br />&#160;&#160;&#160;&#160;) -&gt; <a class="enum" href="{{channel}}/core/option/enum.Option.html" title="enum core::option::Option">Option</a>&lt;<a class="enum" href="{{channel}}/core/result/enum.Result.html" title="enum core::result::Result">Result</a>&lt;<a class="primitive" href="{{channel}}/std/primitive.usize.html">usize</a>, <a class="struct" href="struct.Error.html" title="struct foo::Error">Error</a>&gt;&gt;;
34
<span class="item-spacer" /> fn <a href="#tymethod.poll_flush" class="fn">poll_flush</a>(<br />&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;self: <a class="enum" href="{{channel}}/core/option/enum.Option.html" title="enum core::option::Option">Option</a>&lt;<a class="struct" href="{{channel}}/alloc/string/struct.String.html" title="struct alloc::string::String">String</a>&gt;,<br />&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;cx: &amp;mut <a class="enum" href="{{channel}}/core/option/enum.Option.html" title="enum core::option::Option">Option</a>&lt;<a class="struct" href="{{channel}}/alloc/string/struct.String.html" title="struct alloc::string::String">String</a>&gt;<br />&#160;&#160;&#160;&#160;) -&gt; <a class="enum" href="{{channel}}/core/option/enum.Option.html" title="enum core::option::Option">Option</a>&lt;<a class="enum" href="{{channel}}/core/result/enum.Result.html" title="enum core::result::Result">Result</a>&lt;<a class="primitive" href="{{channel}}/std/primitive.unit.html">()</a>, <a class="struct" href="struct.Error.html" title="struct foo::Error">Error</a>&gt;&gt;;
45
<span class="item-spacer" /> fn <a href="#tymethod.poll_close" class="fn">poll_close</a>(<br />&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;self: <a class="enum" href="{{channel}}/core/option/enum.Option.html" title="enum core::option::Option">Option</a>&lt;<a class="struct" href="{{channel}}/alloc/string/struct.String.html" title="struct alloc::string::String">String</a>&gt;,<br />&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;cx: &amp;mut <a class="enum" href="{{channel}}/core/option/enum.Option.html" title="enum core::option::Option">Option</a>&lt;<a class="struct" href="{{channel}}/alloc/string/struct.String.html" title="struct alloc::string::String">String</a>&gt;<br />&#160;&#160;&#160;&#160;) -&gt; <a class="enum" href="{{channel}}/core/option/enum.Option.html" title="enum core::option::Option">Option</a>&lt;<a class="enum" href="{{channel}}/core/result/enum.Result.html" title="enum core::result::Result">Result</a>&lt;<a class="primitive" href="{{channel}}/std/primitive.unit.html">()</a>, <a class="struct" href="struct.Error.html" title="struct foo::Error">Error</a>&gt;&gt;;
56

7+
// Provided method
68
fn <a href="#method.poll_write_vectored" class="fn">poll_write_vectored</a>(<br />&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;self: <a class="enum" href="{{channel}}/core/option/enum.Option.html" title="enum core::option::Option">Option</a>&lt;<a class="struct" href="{{channel}}/alloc/string/struct.String.html" title="struct alloc::string::String">String</a>&gt;,<br />&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;cx: &amp;mut <a class="enum" href="{{channel}}/core/option/enum.Option.html" title="enum core::option::Option">Option</a>&lt;<a class="struct" href="{{channel}}/alloc/string/struct.String.html" title="struct alloc::string::String">String</a>&gt;,<br />&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;bufs: &amp;[<a class="primitive" href="{{channel}}/std/primitive.usize.html">usize</a>]<br />&#160;&#160;&#160;&#160;) -&gt; <a class="enum" href="{{channel}}/core/option/enum.Option.html" title="enum core::option::Option">Option</a>&lt;<a class="enum" href="{{channel}}/core/result/enum.Result.html" title="enum core::result::Result">Result</a>&lt;<a class="primitive" href="{{channel}}/std/primitive.usize.html">usize</a>, <a class="struct" href="struct.Error.html" title="struct foo::Error">Error</a>&gt;&gt; { ... }
7-
}</code>
9+
}</code>

‎tests/rustdoc/inline-default-methods.rs

+14-2
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,18 @@
44
extern crate inline_default_methods;
55

66
// @has inline_default_methods/trait.Foo.html
7-
// @has - '//pre[@class="rust item-decl"]' 'fn bar(&self);'
8-
// @has - '//pre[@class="rust item-decl"]' 'fn foo(&mut self) { ... }'
7+
// @has - '//pre[@class="rust item-decl"]' '// Required method fn bar(&self);'
8+
// @has - '//pre[@class="rust item-decl"]' '// Provided method fn foo(&mut self)'
99
pub use inline_default_methods::Foo;
10+
11+
// @has inline_default_methods/trait.Bar.html
12+
// @has - '//pre[@class="rust item-decl"]' '// Required method fn bar(&self);'
13+
// @has - '//pre[@class="rust item-decl"]' '// Provided methods fn foo1(&mut self)'
14+
// @has - '//pre[@class="rust item-decl"]' 'fn foo2(&mut self)'
15+
pub use inline_default_methods::Bar;
16+
17+
// @has inline_default_methods/trait.Baz.html
18+
// @has - '//pre[@class="rust item-decl"]' '// Required methods fn bar1(&self);'
19+
// @has - '//pre[@class="rust item-decl"]' 'fn bar2(&self);'
20+
// @has - '//pre[@class="rust item-decl"]' '// Provided method fn foo(&mut self)'
21+
pub use inline_default_methods::Baz;

‎tests/rustdoc/issue-85454.rs

+2-2
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@
55
extern crate issue_85454;
66

77
// @has foo/trait.FromResidual.html
8-
// @has - '//pre[@class="rust item-decl"]' 'pub trait FromResidual<R = <Self as Try>::Residual> { fn from_residual(residual: R) -> Self; }'
8+
// @has - '//pre[@class="rust item-decl"]' 'pub trait FromResidual<R = <Self as Try>::Residual> { // Required method fn from_residual(residual: R) -> Self; }'
99
pub trait FromResidual<R = <Self as Try>::Residual> {
1010
fn from_residual(residual: R) -> Self;
1111
}
@@ -24,6 +24,6 @@ pub enum ControlFlow<B, C = ()> {
2424

2525
pub mod reexport {
2626
// @has foo/reexport/trait.FromResidual.html
27-
// @has - '//pre[@class="rust item-decl"]' 'pub trait FromResidual<R = <Self as Try>::Residual> { fn from_residual(residual: R) -> Self; }'
27+
// @has - '//pre[@class="rust item-decl"]' 'pub trait FromResidual<R = <Self as Try>::Residual> { // Required method fn from_residual(residual: R) -> Self; }'
2828
pub use issue_85454::*;
2929
}

‎tests/rustdoc/where.SWhere_TraitWhere_item-decl.html

+5-5
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
11
<pre class="rust item-decl"><code>pub trait TraitWhere {
2-
type <a href="#associatedtype.Item" class="associatedtype">Item</a>&lt;'a&gt;<br />&#160;&#160;&#160;&#160;<span class="where">where<br />&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;Self: 'a</span>;
2+
type <a href="#associatedtype.Item" class="associatedtype">Item</a>&lt;'a&gt;<br />&#160;&#160;&#160;&#160;&#160;&#160;&#160;<span class="where">where Self: 'a</span>;
33

4-
fn <a href="#method.func" class="fn">func</a>(self)<br />&#160;&#160;&#160;&#160;<span class="where">where<br />&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;Self: <a class="trait" href="{{channel}}/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a></span>,
5-
{ ... }
6-
<span class="item-spacer" /> fn <a href="#method.lines" class="fn">lines</a>(self) -&gt; <a class="struct" href="{{channel}}/std/io/struct.Lines.html" title="struct std::io::Lines">Lines</a>&lt;Self&gt;<br />&#160;&#160;&#160;&#160;<span class="where">where<br />&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;Self: <a class="trait" href="{{channel}}/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a></span>,
7-
{ ... }
4+
// Provided methods
5+
fn <a href="#method.func" class="fn">func</a>(self)<br />&#160;&#160;&#160;&#160;&#160;&#160;&#160;<span class="where">where Self: <a class="trait" href="{{channel}}/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a></span> { ... }
6+
<span class="item-spacer" /> fn <a href="#method.lines" class="fn">lines</a>(self) -&gt; <a class="struct" href="{{channel}}/std/io/struct.Lines.html" title="struct std::io::Lines">Lines</a>&lt;Self&gt;<br />&#160;&#160;&#160;&#160;&#160;&#160;&#160;<span class="where">where Self: <a class="trait" href="{{channel}}/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a></span> { ... }
7+
<span class="item-spacer" /> fn <a href="#method.merge" class="fn">merge</a>&lt;T&gt;(self, a: T)<br />&#160;&#160;&#160;&#160;&#160;&#160;&#160;<span class="where">where Self: <a class="trait" href="{{channel}}/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a>,<br />&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;T: <a class="trait" href="{{channel}}/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a></span> { ... }
88
}</code></pre>

‎tests/rustdoc/where.rs

+6
Original file line numberDiff line numberDiff line change
@@ -41,6 +41,12 @@ pub trait TraitWhere {
4141
where
4242
Self: Sized,
4343
{ todo!() }
44+
45+
fn merge<T>(self, a: T)
46+
where
47+
Self: Sized,
48+
T: Sized,
49+
{ todo!() }
4450
}
4551

4652
// @has foo/struct.Echo.html '//*[@class="impl"]//h3[@class="code-header"]' \

‎tests/rustdoc/whitespace-after-where-clause.trait.html

+1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
11
<pre class="rust item-decl"><code>pub trait ToOwned&lt;T&gt;<span class="where fmt-newline">where<br />&#160;&#160;&#160;&#160;T: <a class="trait" href="{{channel}}/core/clone/trait.Clone.html" title="trait core::clone::Clone">Clone</a>,</span>{
22
type <a href="#associatedtype.Owned" class="associatedtype">Owned</a>;
33

4+
// Required methods
45
fn <a href="#tymethod.to_owned" class="fn">to_owned</a>(&amp;self) -&gt; Self::<a class="associatedtype" href="trait.ToOwned.html#associatedtype.Owned" title="type foo::ToOwned::Owned">Owned</a>;
56
<span class="item-spacer" /> fn <a href="#tymethod.whatever" class="fn">whatever</a>(&amp;self) -&gt; T;
67
}</code></pre>

‎tests/rustdoc/whitespace-after-where-clause.trait2.html

+1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
11
<pre class="rust item-decl"><code>pub trait ToOwned2&lt;T:&#160;<a class="trait" href="{{channel}}/core/clone/trait.Clone.html" title="trait core::clone::Clone">Clone</a>&gt; {
22
type <a href="#associatedtype.Owned" class="associatedtype">Owned</a>;
33

4+
// Required methods
45
fn <a href="#tymethod.to_owned" class="fn">to_owned</a>(&amp;self) -&gt; Self::<a class="associatedtype" href="trait.ToOwned2.html#associatedtype.Owned" title="type foo::ToOwned2::Owned">Owned</a>;
56
<span class="item-spacer" /> fn <a href="#tymethod.whatever" class="fn">whatever</a>(&amp;self) -&gt; T;
67
}</code></pre>

0 commit comments

Comments
 (0)