Opened 11 years ago
Closed 11 years ago
#22141 closed Cleanup/optimization (fixed)
Add spell checker for documentation
Reported by: | beregond | Owned by: | Tim Graham |
---|---|---|---|
Component: | Documentation | Version: | dev |
Severity: | Normal | Keywords: | |
Cc: | Triage Stage: | Accepted | |
Has patch: | yes | Needs documentation: | no |
Needs tests: | no | Patch needs improvement: | yes |
Easy pickings: | no | UI/UX: | no |
Description
Spell checker would find all typos in documentation in automatic way. Thanks to it people will be able to automatically check if all they wrote are proper words.
There already exists PR for that: https://github.com/django/django/pull/2354
Change History (6)
follow-up: 4 comment:1 by , 11 years ago
comment:2 by , 11 years ago
Has patch: | set |
---|---|
Owner: | changed from | to
Status: | new → assigned |
Summary: | Add spell checker → Add spell checker for documentation |
Triage Stage: | Unreviewed → Accepted |
I think I would probably be willing to look after this. I will try to review the PR soon.
comment:3 by , 11 years ago
EvilDMP - perfectly there is no need to add new words, but if it happens that someone adds word to docs, that is not recognized, and he notices the mistake, he should just add this word to wordlist, so then it is clear (in PR) that he added particular word. In the end developers that make changes SHOULD maintain the wordlist. (It is possible to add this check as test, so if someone will modify docs and this test will fail, he will either fix his typo or add this word to whitelist.)
comment:4 by , 11 years ago
Replying to EvilDMP:
It's a spelling checker by the way. A spell checker would be useful for a wizard. (I'm aware that this particular boat sailed long ago...)
Yes. Magic removal landed almost 8 years ago. Spell checking is no longer required.
(/rimshot)
comment:5 by , 11 years ago
Patch needs improvement: | set |
---|
comment:6 by , 11 years ago
Resolution: | → fixed |
---|---|
Status: | assigned → closed |
This is neat, but as bmispelon asked, who is going to be curating - i.e. maintaining - the list?
It's a spelling checker by the way. A spell checker would be useful for a wizard. (I'm aware that this particular boat sailed long ago...)