Skip to content

Remove broken footnote links from grammar summary #1794

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Apr 17, 2025
Merged

Remove broken footnote links from grammar summary #1794

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
39 changes: 24 additions & 15 deletions mdbook-spec/src/grammar/render_markdown.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -64,7 +64,8 @@ impl Production {
name = self.name,
)
.unwrap();
self.expression.render_markdown(link_map, output);
self.expression
.render_markdown(link_map, output, for_summary);
output.push('\n');
}
}
Expand All @@ -91,11 +92,16 @@ impl Expression {
}
}

fn render_markdown(&self, link_map: &HashMap<String, String>, output: &mut String) {
fn render_markdown(
&self,
link_map: &HashMap<String, String>,
output: &mut String,
for_summary: bool,
) {
match &self.kind {
ExpressionKind::Grouped(e) => {
output.push_str("( ");
e.render_markdown(link_map, output);
e.render_markdown(link_map, output, for_summary);
if !matches!(e.last(), ExpressionKind::Break(_)) {
output.push(' ');
}
Expand All @@ -104,7 +110,7 @@ impl Expression {
ExpressionKind::Alt(es) => {
let mut iter = es.iter().peekable();
while let Some(e) = iter.next() {
e.render_markdown(link_map, output);
e.render_markdown(link_map, output, for_summary);
if iter.peek().is_some() {
if !matches!(e.last(), ExpressionKind::Break(_)) {
output.push(' ');
Expand All @@ -116,34 +122,34 @@ impl Expression {
ExpressionKind::Sequence(es) => {
let mut iter = es.iter().peekable();
while let Some(e) = iter.next() {
e.render_markdown(link_map, output);
e.render_markdown(link_map, output, for_summary);
if iter.peek().is_some() && !matches!(e.last(), ExpressionKind::Break(_)) {
output.push(' ');
}
}
}
ExpressionKind::Optional(e) => {
e.render_markdown(link_map, output);
e.render_markdown(link_map, output, for_summary);
output.push_str("<sup>?</sup>");
}
ExpressionKind::Repeat(e) => {
e.render_markdown(link_map, output);
e.render_markdown(link_map, output, for_summary);
output.push_str("<sup>\\*</sup>");
}
ExpressionKind::RepeatNonGreedy(e) => {
e.render_markdown(link_map, output);
e.render_markdown(link_map, output, for_summary);
output.push_str("<sup>\\* (non-greedy)</sup>");
}
ExpressionKind::RepeatPlus(e) => {
e.render_markdown(link_map, output);
e.render_markdown(link_map, output, for_summary);
output.push_str("<sup>+</sup>");
}
ExpressionKind::RepeatPlusNonGreedy(e) => {
e.render_markdown(link_map, output);
e.render_markdown(link_map, output, for_summary);
output.push_str("<sup>+ (non-greedy)</sup>");
}
ExpressionKind::RepeatRange(e, a, b) => {
e.render_markdown(link_map, output);
e.render_markdown(link_map, output, for_summary);
write!(
output,
"<sup>{}..{}</sup>",
Expand Down Expand Up @@ -174,7 +180,7 @@ impl Expression {
ExpressionKind::Charset(set) => charset_render_markdown(set, link_map, output),
ExpressionKind::NegExpression(e) => {
output.push('~');
e.render_markdown(link_map, output);
e.render_markdown(link_map, output, for_summary);
}
ExpressionKind::Unicode(s) => {
output.push_str("U+");
Expand All @@ -184,9 +190,12 @@ impl Expression {
if let Some(suffix) = &self.suffix {
write!(output, "<sub class=\"grammar-text\">{suffix}</sub>").unwrap();
}
if let Some(footnote) = &self.footnote {
// The ZeroWidthSpace is to avoid conflicts with markdown link references.
write!(output, "&ZeroWidthSpace;[^{footnote}]").unwrap();
if !for_summary {
if let Some(footnote) = &self.footnote {
// The `ZeroWidthSpace` is to avoid conflicts with markdown link
// references.
write!(output, "&ZeroWidthSpace;[^{footnote}]").unwrap();
}
}
}
}
Expand Down