Update the README to elaborate on case-sensitivity in ignored words
and dictionaries.
Add an additional "Ignoring Words" section, with internal link from the
"noteworthy flags" overview.
Co-authored-by: Peter Newman <peternewman@users.noreply.github.com>
Co-authored-by: Dimitri Papadopoulos Orfanos <3234522+DimitriPapadopoulos@users.noreply.github.com>
* Update README around multi-dictionary changes
* Counting grammar fix
* Add back some removed information
* Improve the wording
* More attempts to cover multiple dictionaries in the readme
* Revert another edit about the trailing comma
* Apply suggestions from code review
Co-authored-by: Eric Larson <larson.eric.d@gmail.com>
* Read options from config
* Fix assert in test
* Fix tests
* Fix readme to pass rst checks in Travis
* Also support .codespellrc config file
* Fix flake8 error
* CLI args override config args
* Rename tool:codespell to just codespell in config
* Fix typo in readme
* Remove unnecessary check for existance of config files (configparser already handles this case)
* Update .travis.yml
* Add more debugging to make
* Removing some extra make debug
* Warn if the dictionary tests won't be run
* Remove the make verbosity again
* Install the required dependencies
* Try and install via the right version of pip
* Add a dev extras section
* Switch to the dev extras to install the codespell dev packages
* Install the codespell dev packages via pip
* We need to checkout to have our file
* Install general dependencies
* Add more stuff to extras
* Install the extras from the right directory
Also move more stuff to extras
* Remove the packages installed via the dev packaging and standardise the order with Travis
* Fix the flake8 warnings
* Make the missing test dependencies a fatal error
* Add a note about dev to the readme
* Update README.rst formatting
Co-authored-by: Eric Larson <larson.eric.d@gmail.com>
* Tweak licence detail formatting
Co-authored-by: Eric Larson <larson.eric.d@gmail.com>
* Pull coverage in as a dependency
* Pull coverage in as a dependency
* Add flake8 to our dev and sort the requirements
* Add a check action which calls flake8, check-manifest and check-dictionaries
* Add the other bits of checking to Makefile
* Switch to make check
* Try running make check on appveyor
* Add a note about make check
* No make on appveyor
Co-authored-by: Eric Larson <larson.eric.d@gmail.com>
* Add renaming advice based on IETF draft-knodel-terminology-00
Add a new "usage" dictionary with usage advice based on:
https://tools.ietf.org/id/draft-knodel-terminology-00.html#rfc.section.1.1.1
Offer to replace master/slave with:
- Primary-secondary
- Leader-follower
- Active-standby
- Primary-replica
- Writer-reader
- Coordinator-worker
- Parent-helper
* Move recommended terms to "usage" dictionary
Backout the changes from commit 98ab0fa and move them into the
"usage" dictionary.
* Fix use of "whitelist" in README
Use the recommended replacement "allowlist"
* Update codespell_lib/_codespell.py
Co-authored-by: Eric Larson <larson.eric.d@gmail.com>
* Check all the dictionaries are sorted
* Sort and trim all dictionaries
* Add a github action to run make check-dictionary
* Fix the grammar of the tasks, but keep the old ones for backwards compatibility
* Use the new Makefile methods everywhere and update docs
* Sort the dictionaries
