Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

The source is auto-formatted with ruff, not black #798

Merged
merged 2 commits into from
Jun 14, 2024
Merged

The source is auto-formatted with ruff, not black #798

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
b590ce1
The source is auto-formatted with ruff, not black
DimitriPapadopoulos May 10, 2024
0b1db50
Merge branch 'main' into black_ruff
brettcannon Jun 14, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 3 additions & 3 deletions docs/development/submitting-patches.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ follow the directions on the :doc:`security page </security>`.
Code
----

This project's source is auto-formatted with |black|. You can check if your
This project's source is auto-formatted with |ruff|. You can check if your
code meets our requirements by running our linters against it with ``nox -s
lint`` or ``pre-commit run --all-files``.

Expand Down Expand Up @@ -67,8 +67,8 @@ So, specifically:
* Use Sphinx parameter/attribute documentation `syntax`_.


.. |black| replace:: ``black``
.. _black: https://pypi.org/project/black/
.. |ruff| replace:: ``ruff``
.. _ruff: https://astral.sh/ruff
.. _`Write comments as complete sentences.`: https://nedbatchelder.com/blog/201401/comments_should_be_sentences.html
.. _`syntax`: https://www.sphinx-doc.org/en/master/usage/restructuredtext/field-lists.html
.. _`Studies have shown`: https://www.microsoft.com/en-us/research/publication/characteristics-of-useful-code-reviews-an-empirical-study-at-microsoft/