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

Spellcheck doesn't recognize <code> tags #260

Closed
jyn514 opened this issue Mar 30, 2022 · 1 comment · Fixed by #262
Closed

Spellcheck doesn't recognize <code> tags #260

jyn514 opened this issue Mar 30, 2022 · 1 comment · Fixed by #262
Assignees
Labels
bug Something isn't working

Comments

@jyn514
Copy link

jyn514 commented Mar 30, 2022

Describe the bug

rust-lang/rust#74697 (comment)

error: spellcheck(Hunspell)
     --> rust/library/std/src/path.rs:2685
      |
 2685 |  The iterator will yield instances of <code>[io::Result]<[fs::DirEntry]></code>. New
      |                                              ^^
      | - oi, Io, oo, ii, ion, bio, Rio, or one of 7 others
      |
      |   Possible spelling mistake found.

This is not a mistake, <code> does exactly the same thing as backticks but with HTML tags instead. Libstd uses them to allow nesting HTML tags, or occasionally because rustdoc renders adjacent inline code blocks poorly.

To Reproduce:

  1. A file containing
<code>std::io</code>
  1. Run cargo spellcheck ...
  2. ...

Expected behavior

Screenshots

Please complete the following information:

  • System:
  • Obtained:
  • Version:

Additional context

@jyn514 jyn514 added the bug Something isn't working label Mar 30, 2022
@jyn514
Copy link
Author

jyn514 commented Mar 30, 2022

This also looks like a bug, it doesn't recognize HTML entities.

error: spellcheck(Hunspell)
     --> rust/library/std/src/path.rs:1609
      |
 1609 |  Converts a <code>[Box]&lt;[Path]&gt;</code> into a [`PathBuf`].
      |                                  ^
      |   Possible spelling mistake found

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

Successfully merging a pull request may close this issue.

2 participants