Skip to content

Commit

Permalink
Mention linting (#11445)
Browse files Browse the repository at this point in the history
* Mention linting

* Fix whitespace that the linter doesnt catch

* Review fixes
  • Loading branch information
plaindocs committed Jul 3, 2024
1 parent d406770 commit 8401ea6
Showing 1 changed file with 15 additions and 0 deletions.
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.

Word list
---------

Expand Down

0 comments on commit 8401ea6

Please sign in to comment.