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.

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

Mention linting #11445

Merged
merged 3 commits into from
Jul 3, 2024
Merged
Changes from all commits
Commits
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
15 changes: 15 additions & 0 deletions docs/dev/style-guide.rst
Original file line number Diff line number Diff line change
Expand Up @@ -49,6 +49,21 @@ Content
* ``:guilabel:`<your username>` dropdown``
* Make sure that **all bullet list items end with a period**, and don't mix periods with no periods.

Linting
~~~~~~~

ReStructuredText for both the RTD user documentation and this developer documentation is linted with `pre-commit` for broken links,
whitespace consistency, and other minor issues.

You can fix many linting issues automatically by installing and running `pre-commit` locally.
To run it on content you have have already committed, use the ``--from-ref`` and ``--to-ref`` `flags <https://pre-commit.com/#pre-commit-run>`__.

.. code-block:: bash

pre-commit run --from-ref <OLDER_COMMIT> --to-ref <RECENT_COMMIT>

Or use ``pre-commit run --all-files`` to lint all files.

plaindocs marked this conversation as resolved.
Show resolved Hide resolved
Word list
---------

Expand Down