Rollup merge of #109351 - GuillaumeGomez:no-footnote-in-summary, r=notriddle

rustdoc: Remove footnote references from doc summary

Since it's one line, we don't have the footnote definition so it doesn't make sense to have the reference.

Part of https://github.com/rust-lang/rust/issues/109024.

r? `@notriddle`
This commit is contained in:
Matthias Krüger 2023-03-20 07:10:33 +01:00 committed by GitHub
commit 39e09ac334
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
2 changed files with 30 additions and 1 deletions

View File

@ -556,7 +556,15 @@ fn check_if_allowed_tag(t: &Tag<'_>) -> bool {
}
fn is_forbidden_tag(t: &Tag<'_>) -> bool {
matches!(t, Tag::CodeBlock(_) | Tag::Table(_) | Tag::TableHead | Tag::TableRow | Tag::TableCell)
matches!(
t,
Tag::CodeBlock(_)
| Tag::Table(_)
| Tag::TableHead
| Tag::TableRow
| Tag::TableCell
| Tag::FootnoteDefinition(_)
)
}
impl<'a, I: Iterator<Item = Event<'a>>> Iterator for SummaryLine<'a, I> {
@ -589,6 +597,10 @@ fn next(&mut self) -> Option<Self::Item> {
is_start = false;
check_if_allowed_tag(c)
}
Event::FootnoteReference(_) => {
self.skipped_tags += 1;
false
}
_ => true,
};
if !is_allowed_tag {

View File

@ -0,0 +1,17 @@
// This test ensures that no footnote reference is generated inside
// summary doc.
#![crate_name = "foo"]
// @has 'foo/index.html'
// @has - '//*[@class="desc docblock-short"]' 'hello bla'
// @!has - '//*[@class="desc docblock-short"]/sup' '1'
// @has 'foo/struct.S.html'
// @has - '//*[@class="docblock"]//sup' '1'
// @has - '//*[@class="docblock"]' 'hello 1 bla'
/// hello [^foot] bla
///
/// [^foot]: blabla
pub struct S;