Skip to content

Commit

Permalink
Rollup merge of #109351 - GuillaumeGomez:no-footnote-in-summary, r=no…
Browse files Browse the repository at this point in the history
…triddle

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 #109024.

r? `@notriddle`
  • Loading branch information
matthiaskrgr authored Mar 20, 2023
2 parents fb4f015 + 5a752cd commit 39e09ac
Show file tree
Hide file tree
Showing 2 changed files with 30 additions and 1 deletion.
14 changes: 13 additions & 1 deletion src/librustdoc/html/markdown.rs
Original file line number Diff line number Diff line change
Expand Up @@ -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> {
Expand Down Expand Up @@ -589,6 +597,10 @@ impl<'a, I: Iterator<Item = Event<'a>>> Iterator for SummaryLine<'a, I> {
is_start = false;
check_if_allowed_tag(c)
}
Event::FootnoteReference(_) => {
self.skipped_tags += 1;
false
}
_ => true,
};
if !is_allowed_tag {
Expand Down
17 changes: 17 additions & 0 deletions tests/rustdoc/footnote-in-summary.rs
Original file line number Diff line number Diff line change
@@ -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;

0 comments on commit 39e09ac

Please sign in to comment.