actions/typos
1
0
Fork 0
mirror of https://github.com/crate-ci/typos.git synced 2024-11-22 00:51:11 -05:00
Code Issues Projects Releases Packages Wiki Activity Actions

docs: Switch from blacklist language

Browse source
This commit is contained in:
Ed Page 2021-04-30 20:49:01 -05:00
parent 4b812e1b96
commit 14f1532bee
2 changed files with 5 additions and 5 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

2
docs/comparison.md
View file

@ -3,7 +3,7 @@
| | typos | [bloom42/misspell][misspell-rs] | [client9/misspell][misspell-go] | [codespell] | [scspell3k] |
|----------------|-----------------------|---------------------------------|---------------------------------|-------------|-------------|
| Runtime | \- | \- | \- | Python | Python |
| Dictionary | Blacklist | Blacklist | Blacklist | Blacklist | Whitelist |
| [Approach](design.md) | Correction | Correction | Correction | Correction | Dictionary |
| Custom Dict | Yes | No | ? | Yes | Yes |
| Per-Lang Dict | Yes | No | ? | No | Yes |
| CamelCase | Yes | No | ? | No | Yes |

8
docs/design.md
View file

@ -20,13 +20,13 @@ Quick feedback and resolution for developer:
## Trade Offs
### typos uses a blacklist
### Corrections vs Dictionaries
Blacklist: Known typos that map to their corresponding word
Corrections: Known misspellings that map to their corresponding dictionary word
- Ignores unknown typos
- Ignores typos that follow c-escapes if they aren't handled correctly
Whitelist: A confidence rating is given for how close a word is to one in the whitelist
Dictionary: A confidence rating is given for how close a word is to one in a dictionary
- Sensitive to false positives due to hex numbers and c-escapes
- Traditional spell checkers use a whitelist.
- Traditional spell checkers use a dictionary.