Skip to content
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

Documentation uses in the markdown, but it's rendered as 1 #9056

Closed
jyn514 opened this issue Jan 8, 2021 · 1 comment
Closed

Documentation uses in the markdown, but it's rendered as 1 #9056

jyn514 opened this issue Jan 8, 2021 · 1 comment
Labels
C-bug Category: bug

Comments

@jyn514
Copy link
Member

jyn514 commented Jan 8, 2021

This is not so much a bug as an oddity (I noticed it while tracking down another bug in deadlinks: deadlinks/cargo-deadlinks#133 (comment)). In https://github.com/rust-lang/cargo/blob/94e21ada550f91f5d32f2f51635792a79aeb8d63/src/doc/src/reference/build-script-examples.md#build-script-examples, the link shows †, but it shows up differently when rendered:

image
image

I assume that's not intentional? Is this a mdbook bug maybe - I think footnotes are an mdbook extension? The links work fine, it just seems odd.

@jyn514 jyn514 added the C-bug Category: bug label Jan 8, 2021
@ehuss
Copy link
Contributor

ehuss commented Jan 8, 2021

I wouldn't consider it a bug. The footnote references can be any sort of label (a word for example), and those get numbered sequentially. That makes it easier to maintain so you don't have to renumber footnotes when they are added/removed. It could be changed to a more descriptive label, but I'm not sure it really matters.

@jyn514 jyn514 closed this as completed Jan 8, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
C-bug Category: bug
Projects
None yet
Development

No branches or pull requests

2 participants