diff --git a/docs/dev/style-guide.rst b/docs/dev/style-guide.rst index 6ad64a130f0..f701ac08143 100644 --- a/docs/dev/style-guide.rst +++ b/docs/dev/style-guide.rst @@ -49,6 +49,21 @@ Content * ``:guilabel:`` 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 `__. + +.. code-block:: bash + + pre-commit run --from-ref --to-ref + +Or use ``pre-commit run --all-files`` to lint all files. + Word list ---------