Skip to content

Commit ac93772

Browse files
committed
docs: reflect changes of python/cpython#143149
1 parent 7e6a146 commit ac93772

File tree

4 files changed

+14
-17
lines changed

4 files changed

+14
-17
lines changed

.github/workflows/lint.yml

Lines changed: 1 addition & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,4 @@ jobs:
99

1010
steps:
1111
- uses: actions/checkout@v6
12-
- uses: actions/setup-python@v6
13-
with:
14-
python-version: "3.x"
15-
- uses: pre-commit/action@v3.0.1
12+
- uses: j178/prek-action@v1

Makefile

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -95,13 +95,13 @@ _ensure-package: venv
9595
$(VENVDIR)/bin/python3 -m pip install $(PACKAGE); \
9696
fi
9797

98-
.PHONY: _ensure-pre-commit
99-
_ensure-pre-commit:
100-
make _ensure-package PACKAGE=pre-commit
98+
.PHONY: _ensure-prek
99+
_ensure-prek:
100+
make _ensure-package PACKAGE=prek
101101

102102
.PHONY: lint
103-
lint: _ensure-pre-commit
104-
$(VENVDIR)/bin/python3 -m pre_commit run --all-files
103+
lint: _ensure-prek
104+
$(VENVDIR)/bin/python3 -m prek run --all-files
105105

106106
# Generate all release cycle files together with a single script invocation
107107
# Use branches.csv as the primary target, others depend on it

getting-started/pull-request-lifecycle.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -111,7 +111,7 @@ You should have already :ref:`set up your system <setup>`,
111111

112112
(Learn more about :ref:`good-commits`)
113113

114-
* If your code isn't linted correctly, :ref:`pre-commit <install-pre-commit>`
114+
* If your code isn't linted correctly, :ref:`prek <install-prek>`
115115
will block the commit with an error message, for example::
116116

117117
Doc/library/stdtypes.rst:5718: No newline at end of file. (missing-final-newline)

getting-started/setup-building.rst

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -135,18 +135,18 @@ affected files as described below.)
135135
Changes for the documentation can be made from the same repository; see
136136
:ref:`documenting`.
137137

138-
.. _install-pre-commit:
138+
.. _install-prek:
139139

140-
Install pre-commit as a Git hook
141-
--------------------------------
140+
Install prek as a Git hook
141+
--------------------------
142142

143143
To make sure your code is linted correctly, we recommend setting up
144-
`pre-commit <https://pre-commit.com#installation>`__ as a Git hook::
144+
`prek <https://prek.j178.dev/installation/>`__ as a Git hook::
145145

146-
$ pre-commit install --allow-missing-config
147-
pre-commit installed at .git/hooks/pre-commit
146+
$ prek install --allow-missing-config
147+
prek installed at .git/hooks/pre-commit
148148

149-
Now pre-commit will run automatically on ``git commit``.
149+
Now prek will run automatically on ``git commit``.
150150

151151
.. c_get_source_code_end
152152

0 commit comments

Comments
 (0)