Skip to content

README: Document how to use pre-commit #2639

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

Merged
merged 1 commit into from
Dec 12, 2022
Merged

README: Document how to use pre-commit #2639

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
23 changes: 23 additions & 0 deletions README.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -154,6 +154,29 @@ config files.

.. _tomli: https://pypi.org/project/tomli/

`pre-commit <https://pre-commit.com/>`_ hook
--------------------------------------------

codespell also works with `pre-commit`, using

.. code-block:: yaml

- repo: https://github.com/codespell-project/codespell
rev: v2.2.2
hooks:
- id: codespell

If one configures codespell using the `pyproject.toml` file instead use:

.. code-block:: yaml

- repo: https://github.com/codespell-project/codespell
rev: v2.2.2
hooks:
- id: codespell
additional_dependencies:
- tomli

Dictionary format
-----------------

Expand Down