Name the files for what they act on
The names for the config files aren't particularly obvious to everyone.
- What each file acts on isn't obvious (some act on the dictionary, some on file content, some on the results of the spell checker, some on the resulting comment)
- The file format for each file isn't obvious (and it varies significantly)
This is a proposal, I'm still playing with it.
|Single word-per line||txt||words|
|Perl Regular Expression||txt||patterns|
Overview of changes
|Dictionary||Replace base dictionary||words||dictionary||dictionary|
|Dictionary||Add items to dictionary||words||allow||dictionary_additions|
|Dictionary||Remove items from dictionary||patterns||reject||dictionary_removals|
|Files||Limit file checking||patterns||only||file_exclusive|
|Content||Mask file content||patterns||patterns||line_masks|
|Output||Acknowledge some word-like things that aren't in the dictionary||words||expect||word_expectations|
|Output||Help users respond to the bot||md||advice||