Skip to content

Commit cca2694

Browse files
committed
Include a note about docs formatting/linting to CONTRIBUTING.rst
1 parent 37de8ae commit cca2694

File tree

1 file changed

+4
-3
lines changed

1 file changed

+4
-3
lines changed

CONTRIBUTING.rst

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -88,7 +88,7 @@ Install poetry_ and poethepoet_ using pipx_:
8888

8989
.. admonition:: Check ``tool.pipx-install`` section in ``pyproject.toml`` to see supported versions
9090

91-
::
91+
.. code-block:: toml
9292
9393
[tool.pipx-install]
9494
poethepoet = ">=0.26"
@@ -279,13 +279,14 @@ There are a few coding conventions we use in beets:
279279
Style
280280
~~~~~
281281

282-
We use ruff_ to format and lint the codebase.
282+
We use `ruff <https://docs.astral.sh/ruff/>`__ to format and lint the codebase.
283283

284284
Run ``poe check-format`` and ``poe lint`` to check your code for style and
285285
linting errors. Running ``poe format`` will automatically format your code
286286
according to the specifications required by the project.
287287

288-
.. _ruff: https://docs.astral.sh/ruff/
288+
Similarly, run ``poe format-docs`` and ``poe lint-docs`` to ensure consistent
289+
documentation formatting and check for any issues.
289290

290291
Handling Paths
291292
~~~~~~~~~~~~~~

0 commit comments

Comments
 (0)