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

Jump to bottom

Consistent title case capitalisation #3286

Merged
merged 1 commit into from
Jan 12, 2024
Merged

Consistent title case capitalisation #3286

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
12 changes: 6 additions & 6 deletions README.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -116,7 +116,7 @@ Want to know if a word you're proposing exists in codespell already? It is possi

You can select the optional dictionaries with the ``--builtin`` option.

Ignoring Words
Ignoring words
--------------

When ignoring false positives, note that spelling errors are *case-insensitive* but words to ignore are *case-sensitive*. For example, the dictionary entry ``wrod`` will also match the typo ``Wrod``, but to ignore it you must pass ``wrod``.
Expand Down Expand Up @@ -191,10 +191,10 @@ config files.

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

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

codespell also works with `pre-commit`, using
codespell also works with `pre-commit <https://pre-commit.com/>`_, using

.. code-block:: yaml

Expand Down Expand Up @@ -248,7 +248,7 @@ applied directly, but should instead be manually inspected. E.g.:

clas->class, clash, disabled because of name clash in c++

Development Setup
Development setup
-----------------

As suggested in the `Python Packaging User Guide`_, ensure ``pip``, ``setuptools``, and ``wheel`` are up to date before installing from source. Specifically you will need recent versions of ``setuptools`` and ``setuptools_scm``:
Expand All @@ -271,7 +271,7 @@ To run tests against the codebase run:

.. _Python Packaging User Guide: https://packaging.python.org/en/latest/tutorials/installing-packages/#requirements-for-installing-packages

Sending Pull Requests
Sending pull requests
---------------------

If you have a suggested typo that you'd like to see merged please follow these steps:
Expand Down
Loading