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.

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

Conversation

traviscross
Copy link
Contributor

Our grammar syntax supports linking to footnotes which we render with the Markdown version. This works when the rendering is done on the same page that the footnote appears.

On the grammar summary page, however, where we also render the grammar, these footnotes are not present, and so the links were all broken.

Let's fix this for now by not rendering these footnote links on the grammar summary page.

@rustbot rustbot added the S-waiting-on-review Status: The marked PR is awaiting review from a maintainer label Apr 17, 2025
@traviscross traviscross force-pushed the TC/remove-broken-footnotes-from-grammar-summary branch from 6148182 to 5207470 Compare April 17, 2025 16:27
@traviscross traviscross changed the title Remove broken footnotes from grammar summary Remove broken footnote links from grammar summary Apr 17, 2025
@traviscross traviscross force-pushed the TC/remove-broken-footnotes-from-grammar-summary branch from 5207470 to bb9245f Compare April 17, 2025 16:28
Copy link
Contributor

@ehuss ehuss left a comment

Choose a reason for hiding this comment

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

Makes sense. I thought I had this on my todo list, but I think I had planned to remove footnotes altogether, and then lost track of this.

@traviscross traviscross force-pushed the TC/remove-broken-footnotes-from-grammar-summary branch from bb9245f to 1bbec1c Compare April 17, 2025 17:20
Our grammar syntax supports linking to footnotes which we render in
the Markdown version.  This works when the rendering is done on the
same page that the footnote appears.

On the grammar summary page, however, where we also render the
grammar, these footnotes are not present, and so the links were all
broken.

Let's fix this for now by not rendering these footnote links on the
grammar summary page.
@traviscross traviscross force-pushed the TC/remove-broken-footnotes-from-grammar-summary branch from 1bbec1c to eefaabb Compare April 17, 2025 17:23
@traviscross traviscross marked this pull request as ready for review April 17, 2025 17:26
@traviscross traviscross added this pull request to the merge queue Apr 17, 2025
@traviscross traviscross removed the S-waiting-on-review Status: The marked PR is awaiting review from a maintainer label Apr 17, 2025
Merged via the queue into master with commit 53561c9 Apr 17, 2025
5 checks passed
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.

3 participants