Skip to content

Commit ab7ff99

Browse files
committed
Moving autofixing section to contributing.rst
1 parent 6e77fe9 commit ab7ff99

File tree

2 files changed

+11
-11
lines changed

2 files changed

+11
-11
lines changed

doc/source/development/contributing.rst

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1610,6 +1610,17 @@ request by pushing to the branch on GitHub::
16101610

16111611
git push origin shiny-new-feature
16121612

1613+
Autofixing formatting errors
1614+
----------------------------
1615+
1616+
We use several styling checks (e.g. ``black``, ``flake8``, ``isort``) which are run after
1617+
you make a pull request. If there is a scenario where any of these checks fail then you
1618+
can comment::
1619+
1620+
@github-actions pre-commit
1621+
1622+
on that pull request. This will trigger a workflow which will autofix formatting errors.
1623+
16131624
Delete your merged branch (optional)
16141625
------------------------------------
16151626

doc/source/development/maintaining.rst

Lines changed: 0 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -151,17 +151,6 @@ Here are some things to check when reviewing a pull request.
151151
for regression fixes and small bug fixes, the next minor milestone otherwise)
152152
* Changes should comply with our :ref:`policies.version`.
153153

154-
Autofixing formatting errors
155-
----------------------------
156-
157-
We use several styling checks (e.g. ``black``, ``flake8``, ``isort``) which are run after
158-
you make a pull request. If there is a scenario where any of these checks fail then you
159-
can comment::
160-
161-
@github-actions pre-commit
162-
163-
on that pull request. This will trigger a workflow which will autofix formatting errors.
164-
165154
Backporting
166155
-----------
167156

0 commit comments

Comments
 (0)