Skip to content

Commit d6b7db2

Browse files
committed
Include a note about docs formatting/linting to CONTRIBUTING.rst
1 parent 2b54dae commit d6b7db2

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"
@@ -272,13 +272,14 @@ There are a few coding conventions we use in beets:
272272
Style
273273
~~~~~
274274

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

277277
Run ``poe check-format`` and ``poe lint`` to check your code for style and
278278
linting errors. Running ``poe format`` will automatically format your code
279279
according to the specifications required by the project.
280280

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

283284
Handling Paths
284285
~~~~~~~~~~~~~~

0 commit comments

Comments
 (0)