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

Adding a footnote gives false positives #315

Open
aatifsyed opened this issue Oct 18, 2023 · 2 comments
Open

Adding a footnote gives false positives #315

aatifsyed opened this issue Oct 18, 2023 · 2 comments
Labels
bug Something isn't working

Comments

@aatifsyed
Copy link
Contributor

aatifsyed commented Oct 18, 2023

Rustdoc supports footnotes1

But adding footnotes as described in the rustdoc documentation gives a false positive:

$ git describe
v0.13.1
$ echo '//! This is an example of a footnote[^note].' > test.rs
$ cargo run --quiet -- check test.rs
error: spellcheck(Hunspell)
  --> /home/aatif/sources/cargo-spellcheck/test.rs:1
   |
 1 |  This is an example of a footnote[^note].
   |                          ^^^^^^^^
   | - footnote note, footnote-note, footnote, or tenderfoot
   |
   |   Possible spelling mistake found.

I have to add spacing before the [^1] to workaround this, but this affects the markup, which I don't think is right.

Sounds like a bug in the markdown parser? It should pass footnote, not footnote[^note] to hunspell

Footnotes

  1. https://doc.rust-lang.org/rustdoc/how-to-write-documentation.html#footnotes

@aatifsyed aatifsyed added the bug Something isn't working label Oct 18, 2023
@drahnr
Copy link
Owner

drahnr commented Oct 18, 2023

See #312 and #311

@drahnr drahnr removed their assignment Oct 18, 2023
@drahnr
Copy link
Owner

drahnr commented Oct 18, 2023

No need to close it, just wanted to point out that it is known, it's not solved yet (input & PRs welcome)

@drahnr drahnr reopened this Oct 18, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Something isn't working
Projects
None yet
Development

No branches or pull requests

2 participants