Opened 3 years ago

Closed 3 years ago

#22141 closed Cleanup/optimization (fixed)

Add spell checker for documentation

Reported by: beregond Owned by: Tim Graham
Component: Documentation Version: master
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)

comment:1 Changed 3 years ago by Daniele Procida

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...)

comment:2 Changed 3 years ago by Tim Graham

Has patch: set
Owner: changed from beregond to Tim Graham
Status: newassigned
Summary: Add spell checkerAdd spell checker for documentation
Triage Stage: UnreviewedAccepted

I think I would probably be willing to look after this. I will try to review the PR soon.

comment:3 Changed 3 years ago by beregond

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 in reply to:  1 Changed 3 years ago by Russell Keith-Magee

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 Changed 3 years ago by Tim Graham

Patch needs improvement: set

comment:6 Changed 3 years ago by Tim Graham <timograham@…>

Resolution: fixed
Status: assignedclosed

In a0f252520291924f8fb7cb0d85f1680294508560:

Fixed #22141 -- Added a spelling checker for documentation.

Note: See TracTickets for help on using tickets.
Back to Top