Open
Description
From #74141:
@pickfire: Did you go through this with some kind of type checkers like cargo-spellcheck?
@euclio: I made a super hacky custom rustdoc pass that ran a spellchecker over markdown compiled to plain text.
It would be great to have a tool that automated spell-checking for the docs. @pickfire suggested cargo spellcheck
which had some trouble with bootstrap. Maybe we could somehow modify it to work with bootstrap so it runs as part of tidy
?
Metadata
Metadata
Assignees
Labels
Area: Documentation for any part of the project, including the compiler, standard library, and toolsCategory: An issue proposing an enhancement or a PR with one.Call for participation: Help is requested to fix this issue.Relevant to the bootstrap subteam: Rust's build system (x.py and src/bootstrap)Relevant to the library team, which will review and decide on the PR/issue.
Type
Projects
Milestone
Relationships
Development
No branches or pull requests
Activity
pickfire commentedon Jul 24, 2020
Maybe we should also ping the author here @drahnr. He may have some ideas?
drahnr commentedon Jul 24, 2020
@pickfire @jyn514 glad to hear there is interest in using
cargo-spellcheck
!The error you see is very most likely caused by an older version which had issues parsing args properly, note that I plan to release
v0.3.0
is planned for this WE / early next week which should resolve quite a few issues.In the meantime you could give yesterdays
alpha.6
release a shot which should have the traversal + arg parse issues resolved (at least works in the CI https://ci.spearow.io/teams/main/pipelines/cargo-spellcheck/jobs/master-validate/builds/117 ) note that the garbled output for multiline comments is the biggest remaining topic for multiline comments in this alpha which will be fixed inv0.3.0
If there are specific issues I would be very happy to get things working for you :)
pickfire commentedon Jul 24, 2020
@drahnr What do you think?
drahnr commentedon Jul 24, 2020
@pickfire As @euclio already stated in #74141 (comment) - it should not be required anymore since
v0.3.0-alpha.4
/ c041dca66b966610d216ec23aeb4cf386adcf54a which incorporates the latesthunspell-sys
which usescc
without anyC
-buildtools to create the static lib from hunspell source files, so that should be ☑️ if not please open a ticket :)pickfire commentedon Jul 24, 2020
It doesn't work and probably displayed the wrong error.
drahnr commentedon Jul 24, 2020
@pickfire could you please open an issue with information on how to reproduce and commit sha / release so I can test / reproduce the issue?
drahnr commentedon Jul 27, 2020
v0.3.0-beta.1
should resolve this and a few more issues with the rust lang code base, let me know if this is sufficient for the time being or if anything particular feature is badly needed.pickfire commentedon Jul 28, 2020
@drahnr I checked, a lot better but still not sufficient yet. Looks like UTF-8 handling still needs some tweak to make it work without panicking.
drahnr commentedon Jul 28, 2020
Found the root cause,
v0.3.0-beta.5
should do the trick 🎉jyn514 commentedon Jul 28, 2020
I tried running it: it showed no output for ~three seconds then exited. With -vvvv I get the following output:
It looks like it's skipping almost all the directories? And not running checks on the ones that it did find, because the /usr/share/* paths weren't found? I would expect both of those to be warnings, not DEBUG logging.
I installed
hunspell
(withsudo apt install hunspell
) and now it appears to at least be doing something:However these warnings aren't particularly helpful -
u32
is a builtin type and~
is not a misspelling, it means approximation. @drahnr is there a way to add a whitelist of keywords or ignore symbols?30 remaining items