Skip to content

feat: Footnote support - #470

Open
epage wants to merge 2 commits into
rust-lang:mainfrom
epage:footnote
Open

epage wants to merge 2 commits into
rust-lang:mainfrom
epage:footnote

Conversation

@epage

@epage epage commented Aug 12, 2026 •

Copy link
Copy Markdown
Contributor

Like with any unicode in title's, the caller is responsible for deciding whether a footnote should have unicode.

In support of superscript footnotes, the caller is responsible for whether to wrap footnote markers in [].

Fixes #450

@epage
epage force-pushed the footnote branch 4 times, most recently from a7f0733 to dd371bc Compare August 19, 2026 16:40
@epage
epage force-pushed the footnote branch 2 times, most recently from 91e6e3b to 00e10e6 Compare August 31, 2026 18:06

@Muscraft Muscraft left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Could you add a test for when there is a level, id, and footnote marker? It looks like ruff has a few tests cases that show this.

Comment thread src/snippet.rs
/// not allowed to be passed to this function.
///
/// </div>
pub fn footnote(mut self, marker: impl Into<OptionCow<'a>>) -> Self {

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Why is this footnote and not footnote_marker?

This branch has not been deployed

No deployments
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Footnotes for titles

2 participants