Skip to content

Commit 7f47462

Browse files
CAM-Gerlachhugovk
andauthored
Improve readme and contributing guide sections further with reviewer feedback
Co-authored-by: Hugo van Kemenade <hugovk@users.noreply.github.com>
1 parent 6cc3ff0 commit 7f47462

File tree

2 files changed

+4
-4
lines changed

2 files changed

+4
-4
lines changed

CONTRIBUTING.rst

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -69,12 +69,12 @@ install, configure and update a suite of hooks that check for
6969
common problems and issues, and fix many of them automatically.
7070

7171
If your system has ``make`` installed, you can run the pre-commit checkers
72-
on the full repo by simply running ``make lint``. Note that this will
72+
on the full repo by running ``make lint``. This will
7373
install pre-commit in the current virtual environment if it isn't already,
7474
so make sure you've activated the environment you want it to use
7575
before running this command.
7676

77-
Otherwise, you can install pre-commit by running ``pip install pre-commit``
77+
Otherwise, you can install pre-commit by running ``python -m pip install pre-commit``
7878
(or your choice of installer), and then run the hooks on all the files
7979
in the repo with ``pre-commit run --all-files``, or only on any files that
8080
have been modified but not yet committed with ``pre-commit run``.
@@ -97,7 +97,7 @@ Like the linters, on a system with ``make`` available, it can be installed
9797
repository with a single command, ``make spellcheck``.
9898

9999
For finer control or on other systems, after installing pre-commit as above
100-
(e.g. ``pip install pre-commit``), you can run it against only the files
100+
(e.g. ``python -m pip install pre-commit``), you can run it against only the files
101101
you've modified and not yet committed with
102102
``pre-commit run --hook-stage manual codespell``, or against all files with
103103
``pre-commit run --all-files --hook-stage manual codespell``.

README.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -49,7 +49,7 @@ intend. To check building the HTML output for your PEP (for example, PEP 12)
4949
using the current default docutils-based system, run the ``pep2html.py`` script
5050
with your PEP source file as its argument (e.g. for PEP 12,
5151
``python -X dev pep2html.py pep-0012.rst``).
52-
If you're on a system with ``make``, you can instead simply execute, e.g.,
52+
If you're on a system with ``make``, you can instead execute, e.g.,
5353
``make pep-0012.rst``.
5454
To generate HTML for all the PEPs, run the script/``make`` without a PEP
5555
file argument.

0 commit comments

Comments
 (0)