Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

README: document simplest usage pattern #2638

Merged
merged 4 commits into from
Dec 12, 2022
Merged

README: document simplest usage pattern #2638

Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
84d25b8
README: document simplest usage pattern
waldyrious Dec 10, 2022
4d838ca
Revert unintended change
waldyrious Dec 10, 2022
9ad70ee
README: indent text that refers to a code block above
waldyrious Dec 12, 2022
c8d5597
Revert indentation changes and apply reviewer suggestion
waldyrious Dec 12, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
17 changes: 15 additions & 2 deletions README.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -34,15 +34,28 @@ You can use ``pip`` to install codespell with e.g.:
Usage
-----

For more in depth info please check usage with ``codespell -h``.
Below are some simple usage examples to demonstrate how the tool works.
For exhaustive usage information, please check the output of ``codespell -h``.

Run codespell in all files of the current directory:

.. code-block:: sh

codespell

Run codespell in specific files or directories (specified via their names or glob patterns):

.. code-block:: sh

codespell some_file some_dir/ *.ext

Some noteworthy flags:

.. code-block:: sh

codespell -w, --write-changes

The ``-w`` flag will actually implement the changes recommended by codespell. Not running 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. Running without the ``-w`` flag is the same as with doing a dry run. It is recommended to run this with the ``-i`` or ``--interactive`` flag.

.. code-block:: sh

Expand Down