"Fossies" - the Fresh Open Source Software Archive  

Source code changes of the file "README.rst" between
codespell-1.16.0.tar.gz and codespell-1.17.1.tar.gz

About: codespell-.* codespell checks source code and other text files for common misspellings.

README.rst  (codespell-1.16.0):README.rst  (codespell-1.17.1)
skipping to change at line 40 skipping to change at line 40
Usage Usage
----- -----
For more in depth info please check usage with ``codespell -h``. For more in depth info please check usage with ``codespell -h``.
Some noteworthy flags:: Some noteworthy flags::
codespell -w, --write-changes codespell -w, --write-changes
The -w flag will actually implement the changes recommended by codespell. Not ru nning with ``-w`` flag is the same as with doing a dry run. It is recommended to run this with the ``-i`` or ``--interactive`` flag.:: The ``-w`` flag will actually implement the changes recommended by codespell. No t running with ``-w`` flag is the same as with doing a dry run. It is recommende d to run this with the ``-i`` or ``--interactive`` flag.::
codespell -I FILE, --ignore-words=FILE codespell -I FILE, --ignore-words=FILE
The -I flag can be used to whitelist certain words that are in the ``codespell_l ib/data/dictionary.txt``. The format of the whitelist file is one word per line. Invoke using: ``codespell -I path/to/file.txt`` to execute codespell referencin g said whitelist. **Important note:** The whitelist passed to ``-I`` is case-sen sitive based on how it is listed in ``dictionary.txt``. :: The ``-I`` flag can be used to whitelist certain words that are in the ``codespe ll_lib/data/dictionary.txt``. The format of the whitelist file is one word per l ine. Invoke using: ``codespell -I path/to/file.txt`` to execute codespell refere ncing said whitelist. **Important note:** The whitelist passed to ``-I`` is case -sensitive based on how it is listed in ``dictionary.txt``. ::
codespell -L word1,word2,word3,word4 codespell -L word1,word2,word3,word4
The -L flag can be used to whitelist certain words that are comma-separated plac ed immediately after it. :: The ``-L`` flag can be used to whitelist certain words that are comma-separated placed immediately after it. ::
codespell -S, --skip= codespell -S, --skip=
Comma-separated list of files to skip. It accepts globs as well. Examples: Comma-separated list of files to skip. It accepts globs as well. Examples:
* to skip .eps & .txt files, invoke ``codespell --skip="*.eps,*.txt"`` * to skip .eps & .txt files, invoke ``codespell --skip="*.eps,*.txt"``
* to skip directories, invoke ``codespell --skip="./src/3rd-Party,./src/Test"`` * to skip directories, invoke ``codespell --skip="./src/3rd-Party,./src/Test"``
Useful commands:: Useful commands::
skipping to change at line 118 skipping to change at line 118
Sending Pull Requests Sending Pull Requests
--------------------- ---------------------
If you have a suggested typo that you'd like to see merged please follow these s teps: If you have a suggested typo that you'd like to see merged please follow these s teps:
1. Make sure you read the instructions mentioned in the ``Dictionary format`` se ction above to submit correctly formatted entries. 1. Make sure you read the instructions mentioned in the ``Dictionary format`` se ction above to submit correctly formatted entries.
2. Sort the dictionary. This is done by invoking (in the top level directory of ``codespell/``):: 2. Sort the dictionary. This is done by invoking (in the top level directory of ``codespell/``)::
make check-dictionary make check-dictionaries
If the make script finds that you need to sort the dictionary, please then ru n:: If the make script finds that you need to sort the dictionary, please then ru n::
make sort-dictionary make sort-dictionaries
3. Only after this process is complete do we recommend you submit the PR. 3. Only after this process is complete do we recommend you submit the PR.
**Important Notes:** **Important Notes:**
* If the dictionary is submitted without being pre-sorted the PR will fail via T ravisCI. * If the dictionary is submitted without being pre-sorted the PR will fail via T ravisCI.
* Not all PRs will be merged. This is pending on the discretion of the devs, mai ntainers, and the community. * Not all PRs will be merged. This is pending on the discretion of the devs, mai ntainers, and the community.
Updating Updating
-------- --------
skipping to change at line 145 skipping to change at line 145
pip install --upgrade git+https://github.com/codespell-project/codespell.git pip install --upgrade git+https://github.com/codespell-project/codespell.git
**Important Notes:** **Important Notes:**
* Sometimes installing via ``pip`` will complain about permissions. If this is t he case then run with :: * Sometimes installing via ``pip`` will complain about permissions. If this is t he case then run with ::
pip install --user --upgrade git+https://github.com/codespell-project/codesp ell.git pip install --user --upgrade git+https://github.com/codespell-project/codesp ell.git
* It has been reported that after installing from ``pip``, codespell can't be lo cated. Please check the $PATH variable to see if ``~/.local/bin`` is present. If it isn't then add it to your path. * It has been reported that after installing from ``pip``, codespell can't be lo cated. Please check the $PATH variable to see if ``~/.local/bin`` is present. If it isn't then add it to your path.
* If you decide to install via ``pip`` then be sure to remove any previously ins talled versions of codespell (via you OSs preferred app manager). * If you decide to install via ``pip`` then be sure to remove any previously ins talled versions of codespell (via your platform's preferred app manager).
Updating the dictionary Updating the dictionary
----------------------- -----------------------
In the scenario where the user prefers not to follow the development version of codespell yet still opts to benefit from the frequently updated `dictionary.txt` file, we recommend running a simple set of commands to achieve this :: In the scenario where the user prefers not to follow the development version of codespell yet still opts to benefit from the frequently updated `dictionary.txt` file, we recommend running a simple set of commands to achieve this ::
wget https://raw.githubusercontent.com/codespell-project/codespell/master/co despell_lib/data/dictionary.txt wget https://raw.githubusercontent.com/codespell-project/codespell/master/co despell_lib/data/dictionary.txt
codespell -D dictionary.txt codespell -D dictionary.txt
The above simply downloads the latest ``dictionary.txt`` file and then by utiliz ing the -D flag allows the user to specify the freshly downloaded ``dictionary.t xt`` as the custom dictionary instead of the default one. The above simply downloads the latest ``dictionary.txt`` file and then by utiliz ing the ``-D`` flag allows the user to specify the freshly downloaded ``dictiona ry.txt`` as the custom dictionary instead of the default one.
License License
------- -------
The Python script ``codespell`` with its library ``codespell_lib`` is available The Python script ``codespell`` with its library ``codespell_lib`` is available
with the following terms: with the following terms:
(*tl;dr*: `GPL v2`_) (*tl;dr*: `GPL v2`_)
Copyright (C) 2010-2011 Lucas De Marchi <lucas.de.marchi@gmail.com> Copyright (C) 2010-2011 Lucas De Marchi <lucas.de.marchi@gmail.com>
 End of changes. 7 change blocks. 
7 lines changed or deleted 7 lines changed or added

Home  |  About  |  Features  |  All  |  Newest  |  Dox  |  Diffs  |  RSS Feeds  |  Screenshots  |  Comments  |  Imprint  |  Privacy  |  HTTP(S)