Skip to content

Commit 5daff8d

Browse files
committed
docs: now source is formatted with ruff
1 parent 04bbc3a commit 5daff8d

File tree

1 file changed

+5
-5
lines changed

1 file changed

+5
-5
lines changed

doc/contributing.rst

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -232,15 +232,15 @@ keep you from sending patches. I can clean them up.
232232

233233
Lines should be kept to a 100-character maximum length. I recommend an
234234
`editorconfig.org`_ plugin for your editor of choice, which will also help with
235-
indentation, line endings and so on.
235+
indentation, line endings and so on. Source files are formatted with `ruff`_.
236+
237+
I use `pre-commit`_ to run checks and formatting when making commits, you
238+
should also.
236239

237240
Other style questions are best answered by looking at the existing code.
238241
Formatting of docstrings, comments, long lines, and so on, should match the
239242
code that already exists.
240243

241-
Many people love auto-formatting with `black`_ or `ruff`_, but I would prefer
242-
not to on coverage.py.
243-
244244

245245
Cog
246246
---
@@ -319,8 +319,8 @@ fixes. If you need help writing tests, please ask.
319319
.. _fork the repo: https://docs.github.com/en/get-started/quickstart/fork-a-repo
320320
.. _editorconfig.org: http://editorconfig.org
321321
.. _tox: https://tox.readthedocs.io/
322-
.. _black: https://pypi.org/project/black/
323322
.. _ruff: https://pypi.org/project/ruff/
323+
.. _pre-commit: https://pre-commit.com/
324324
.. _set_env.py: https://nedbatchelder.com/blog/201907/set_envpy.html
325325
.. _pytest test selectors: https://doc.pytest.org/en/stable/usage.html#specifying-which-tests-to-run
326326
.. _sys.monitoring: https://docs.python.org/3/library/sys.monitoring.html

0 commit comments

Comments
 (0)