From 14f1532bee2560750233c7d7a64312c0e18f5a40 Mon Sep 17 00:00:00 2001 From: Ed Page Date: Fri, 30 Apr 2021 20:49:01 -0500 Subject: [PATCH] docs: Switch from blacklist language --- docs/comparison.md | 2 +- docs/design.md | 8 ++++---- 2 files changed, 5 insertions(+), 5 deletions(-) diff --git a/docs/comparison.md b/docs/comparison.md index 63461b1..8f849b6 100644 --- a/docs/comparison.md +++ b/docs/comparison.md @@ -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 | diff --git a/docs/design.md b/docs/design.md index 5d752fb..033804c 100644 --- a/docs/design.md +++ b/docs/design.md @@ -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.