]> git.evergreen-ils.org Git - Evergreen.git/commit
Docs: Add aspell wordlist to improve spellchecking
authorRemington Steed <rjs7@calvin.edu>
Fri, 16 Mar 2018 15:18:11 +0000 (11:18 -0400)
committerRemington Steed <rjs7@calvin.edu>
Fri, 16 Mar 2018 18:45:19 +0000 (14:45 -0400)
commit2a3afbc194c82131bbe6efeaecef091433045f1b
treef57866f73a62c3b41d11d9bad38720e07a170dbe
parentc89c75b221c8431aa684955fe72d76d355c9c18b
Docs: Add aspell wordlist to improve spellchecking

To spellcheck the docs:

  - Go into the docs/ directory.
  - Copy the wordlist to your home directory (making a backup of your
    existing wordlist, if you have one):
    - cp --backup .aspell.en.pws ~/
  - Run 'aspell' over all AsciiDoc files, except release notes. Don't
    need to create backup files, since we're under version control. This
    runs the interactive spellchecker; use it to fix incorrect words, or
    add new correct words to the wordlist:
    - for f in $(find . -name '*.adoc' -and ! -name 'RELEASE*'); do
      aspell check --ignore-case --dont-backup $f; done
  - Review your changes:
    - git diff
  - Commit spelling corrections in one commit. Noteworthy changes should
    be included in the commit message.
  - Commit changed wordlist in a separate commit.

Signed-off-by: Remington Steed <rjs7@calvin.edu>
docs/.aspell.en.pws [new file with mode: 0644]