Rollup merge of #112927 - GuillaumeGomez:where-clause-indent, r=notriddle
Fix indentation for where clause in rustdoc pages Screenshot of the bug: ![image](https://github.com/rust-lang/rust/assets/3050060/090cfeaa-0edc-46c7-9ea0-e26ac865b2c2) I used this opportunity to clarify the code a bit because some weird things were going on. r? ````@notriddle````
This commit is contained in:
commit
3feee9f1f2
@ -347,13 +347,19 @@ pub(crate) fn print_where_clause<'a, 'tcx: 'a>(
|
|||||||
}
|
}
|
||||||
} else {
|
} else {
|
||||||
let mut br_with_padding = String::with_capacity(6 * indent + 28);
|
let mut br_with_padding = String::with_capacity(6 * indent + 28);
|
||||||
br_with_padding.push_str("\n");
|
br_with_padding.push('\n');
|
||||||
|
|
||||||
let padding_amount =
|
let where_indent = 3;
|
||||||
if ending == Ending::Newline { indent + 4 } else { indent + "fn where ".len() };
|
let padding_amount = if ending == Ending::Newline {
|
||||||
|
indent + 4
|
||||||
|
} else if indent == 0 {
|
||||||
|
4
|
||||||
|
} else {
|
||||||
|
indent + where_indent + "where ".len()
|
||||||
|
};
|
||||||
|
|
||||||
for _ in 0..padding_amount {
|
for _ in 0..padding_amount {
|
||||||
br_with_padding.push_str(" ");
|
br_with_padding.push(' ');
|
||||||
}
|
}
|
||||||
let where_preds = where_preds.to_string().replace('\n', &br_with_padding);
|
let where_preds = where_preds.to_string().replace('\n', &br_with_padding);
|
||||||
|
|
||||||
@ -370,7 +376,8 @@ pub(crate) fn print_where_clause<'a, 'tcx: 'a>(
|
|||||||
let where_preds = where_preds.replacen(&br_with_padding, " ", 1);
|
let where_preds = where_preds.replacen(&br_with_padding, " ", 1);
|
||||||
|
|
||||||
let mut clause = br_with_padding;
|
let mut clause = br_with_padding;
|
||||||
clause.truncate(clause.len() - "where ".len());
|
// +1 is for `\n`.
|
||||||
|
clause.truncate(indent + 1 + where_indent);
|
||||||
|
|
||||||
write!(clause, "<span class=\"where\">where{where_preds}</span>")?;
|
write!(clause, "<span class=\"where\">where{where_preds}</span>")?;
|
||||||
clause
|
clause
|
||||||
|
@ -860,8 +860,8 @@ fn assoc_method(
|
|||||||
w.reserve(header_len + "<a href=\"\" class=\"fn\">{".len() + "</a>".len());
|
w.reserve(header_len + "<a href=\"\" class=\"fn\">{".len() + "</a>".len());
|
||||||
write!(
|
write!(
|
||||||
w,
|
w,
|
||||||
"{indent}{vis}{constness}{asyncness}{unsafety}{defaultness}{abi}fn <a{href} class=\"fn\">{name}</a>\
|
"{indent}{vis}{constness}{asyncness}{unsafety}{defaultness}{abi}fn \
|
||||||
{generics}{decl}{notable_traits}{where_clause}",
|
<a{href} class=\"fn\">{name}</a>{generics}{decl}{notable_traits}{where_clause}",
|
||||||
indent = indent_str,
|
indent = indent_str,
|
||||||
vis = vis,
|
vis = vis,
|
||||||
constness = constness,
|
constness = constness,
|
||||||
|
2
tests/rustdoc/where.SWhere_Echo_impl.html
Normal file
2
tests/rustdoc/where.SWhere_Echo_impl.html
Normal file
@ -0,0 +1,2 @@
|
|||||||
|
<h3 class="code-header">impl<D> <a class="struct" href="struct.Delta.html" title="struct foo::Delta">Delta</a><D><span class="where fmt-newline">where
|
||||||
|
D: <a class="trait" href="trait.MyTrait.html" title="trait foo::MyTrait">MyTrait</a>,</span></h3>
|
@ -1,3 +1,3 @@
|
|||||||
<pre class="rust item-decl"><code>pub struct Simd<T>(_)
|
<pre class="rust item-decl"><code>pub struct Simd<T>(_)
|
||||||
<span class="where">where
|
<span class="where">where
|
||||||
T: <a class="trait" href="trait.MyTrait.html" title="trait foo::MyTrait">MyTrait</a></span>;</code></pre>
|
T: <a class="trait" href="trait.MyTrait.html" title="trait foo::MyTrait">MyTrait</a></span>;</code></pre>
|
||||||
|
3
tests/rustdoc/where.alpha_trait_decl.html
Normal file
3
tests/rustdoc/where.alpha_trait_decl.html
Normal file
@ -0,0 +1,3 @@
|
|||||||
|
<code>pub struct Alpha<A>(_)
|
||||||
|
<span class="where">where
|
||||||
|
A: <a class="trait" href="trait.MyTrait.html" title="trait foo::MyTrait">MyTrait</a></span>;</code>
|
5
tests/rustdoc/where.bravo_trait_decl.html
Normal file
5
tests/rustdoc/where.bravo_trait_decl.html
Normal file
@ -0,0 +1,5 @@
|
|||||||
|
<code>pub trait Bravo<B><span class="where fmt-newline">where
|
||||||
|
B: <a class="trait" href="trait.MyTrait.html" title="trait foo::MyTrait">MyTrait</a>,</span>{
|
||||||
|
// Required method
|
||||||
|
fn <a href="#tymethod.get" class="fn">get</a>(&self, B: B);
|
||||||
|
}</code>
|
2
tests/rustdoc/where.charlie_fn_decl.html
Normal file
2
tests/rustdoc/where.charlie_fn_decl.html
Normal file
@ -0,0 +1,2 @@
|
|||||||
|
<code>pub fn charlie<C>()<span class="where fmt-newline">where
|
||||||
|
C: <a class="trait" href="trait.MyTrait.html" title="trait foo::MyTrait">MyTrait</a>,</span></code>
|
2
tests/rustdoc/where.golf_type_alias_decl.html
Normal file
2
tests/rustdoc/where.golf_type_alias_decl.html
Normal file
@ -0,0 +1,2 @@
|
|||||||
|
<code>pub type Golf<T><span class="where fmt-newline">where
|
||||||
|
T: <a class="trait" href="{{channel}}/core/clone/trait.Clone.html" title="trait core::clone::Clone">Clone</a>,</span> = <a class="primitive" href="{{channel}}/std/primitive.tuple.html">(T, T)</a>;</code>
|
@ -5,16 +5,20 @@
|
|||||||
pub trait MyTrait { fn dummy(&self) { } }
|
pub trait MyTrait { fn dummy(&self) { } }
|
||||||
|
|
||||||
// @has foo/struct.Alpha.html '//pre' "pub struct Alpha<A>(_) where A: MyTrait"
|
// @has foo/struct.Alpha.html '//pre' "pub struct Alpha<A>(_) where A: MyTrait"
|
||||||
|
// @snapshot alpha_trait_decl - '//*[@class="rust item-decl"]/code'
|
||||||
pub struct Alpha<A>(A) where A: MyTrait;
|
pub struct Alpha<A>(A) where A: MyTrait;
|
||||||
// @has foo/trait.Bravo.html '//pre' "pub trait Bravo<B>where B: MyTrait"
|
// @has foo/trait.Bravo.html '//pre' "pub trait Bravo<B>where B: MyTrait"
|
||||||
|
// @snapshot bravo_trait_decl - '//*[@class="rust item-decl"]/code'
|
||||||
pub trait Bravo<B> where B: MyTrait { fn get(&self, B: B); }
|
pub trait Bravo<B> where B: MyTrait { fn get(&self, B: B); }
|
||||||
// @has foo/fn.charlie.html '//pre' "pub fn charlie<C>()where C: MyTrait"
|
// @has foo/fn.charlie.html '//pre' "pub fn charlie<C>()where C: MyTrait"
|
||||||
|
// @snapshot charlie_fn_decl - '//*[@class="rust item-decl"]/code'
|
||||||
pub fn charlie<C>() where C: MyTrait {}
|
pub fn charlie<C>() where C: MyTrait {}
|
||||||
|
|
||||||
pub struct Delta<D>(D);
|
pub struct Delta<D>(D);
|
||||||
|
|
||||||
// @has foo/struct.Delta.html '//*[@class="impl"]//h3[@class="code-header"]' \
|
// @has foo/struct.Delta.html '//*[@class="impl"]//h3[@class="code-header"]' \
|
||||||
// "impl<D> Delta<D>where D: MyTrait"
|
// "impl<D> Delta<D>where D: MyTrait"
|
||||||
|
// @snapshot SWhere_Echo_impl - '//*[@id="impl-Delta%3CD%3E"]/h3[@class="code-header"]'
|
||||||
impl<D> Delta<D> where D: MyTrait {
|
impl<D> Delta<D> where D: MyTrait {
|
||||||
pub fn delta() {}
|
pub fn delta() {}
|
||||||
}
|
}
|
||||||
@ -65,4 +69,5 @@ impl<F> MyTrait for Foxtrot<F>where F: MyTrait {}
|
|||||||
|
|
||||||
// @has foo/type.Golf.html '//pre[@class="rust item-decl"]' \
|
// @has foo/type.Golf.html '//pre[@class="rust item-decl"]' \
|
||||||
// "type Golf<T>where T: Clone, = (T, T)"
|
// "type Golf<T>where T: Clone, = (T, T)"
|
||||||
|
// @snapshot golf_type_alias_decl - '//*[@class="rust item-decl"]/code'
|
||||||
pub type Golf<T> where T: Clone = (T, T);
|
pub type Golf<T> where T: Clone = (T, T);
|
||||||
|
Loading…
Reference in New Issue
Block a user