Improve the definition of the "rare" builtin dictionary

For an end user who is not familiar with the inner details of the
script, the meaning of the old definition was ambiguous. It wasn't
clear whether using this dictionary flags the rare words as errors
(false positives) or on the contrary does not flag these rare words
(false negatives).

Co-authored-by: Peter Newman <peternewman@users.noreply.github.com>
This commit is contained in:
Dimitri Papadopoulos
2021-09-16 18:45:30 +02:00
parent c75f77834b
commit 77c84dba5d

View File

@ -54,7 +54,7 @@ _builtin_dictionaries = (
# realistic for obscure words
('clear', 'for unambiguous errors', '',
False, None, supported_languages_en, None),
('rare', 'for rare but valid words', '_rare',
('rare', 'for rare (but valid) words which are likely to be errors', '_rare', # noqa: E501
None, None, None, None),
('informal', 'for making informal words more formal', '_informal',
True, True, supported_languages_en, supported_languages_en),