Skip to content

Commit 9ddc9a8

Browse files
CAM-Gerlachhugovk
andcommitted
Improve readme and contributing guide sections further with reviewer feedback
Co-authored-by: Hugo van Kemenade <[email protected]>
1 parent b88d052 commit 9ddc9a8

File tree

3 files changed

+16
-14
lines changed

3 files changed

+16
-14
lines changed

.github/CODEOWNERS

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -24,9 +24,11 @@ contents.rst @AA-Turner
2424
generate_rss.py @AA-Turner
2525

2626
# Linting infrastructure
27-
.codespell/ @CAM-Gerlach
28-
.codespellrc @CAM-Gerlach
29-
.pre-commit-config.yaml @CAM-Gerlach
27+
.codespell/ @CAM-Gerlach @hugovk
28+
.codespellrc @CAM-Gerlach @hugovk
29+
.pre-commit-config.yaml @CAM-Gerlach @hugovk
30+
31+
# Git infrastructure
3032
.gitattributes @CAM-Gerlach
3133
.gitignore @CAM-Gerlach
3234

CONTRIBUTING.rst

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -56,8 +56,8 @@ position within the project.
5656
Run pre-commit linting locally
5757
------------------------------
5858

59-
If you'd like, you can run the project's basic linting suite locally,
60-
either on-demand when you choose, or automatically against modified files
59+
You can run this repo's basic linting suite locally,
60+
either on-demand, or automatically against modified files
6161
whenever you commit your changes.
6262

6363
They are also run in CI, so you don't have to run them locally, though doing
@@ -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: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -43,13 +43,13 @@ libraries in the ``pep0`` directory.
4343
Checking PEP formatting and rendering
4444
=====================================
4545

46-
Avoid committing changes with reStructuredText syntax errors that cause PEP
47-
generation to fail, or result in major rendering defects relative to what
48-
you intend. To build the HTML output for your PEP (for example, PEP 12)
46+
Please don't commit changes with reStructuredText syntax errors that cause PEP
47+
generation to fail, or result in major rendering defects relative to what you
48+
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
50-
with your PEP source file as its argument, e.g. for PEP 12,
51-
``python -X dev pep2html.py pep-0012.rst``,
52-
If you're on a system with ``make``, you can instead simply execute, e.g.,
50+
with your PEP source file as its argument (e.g. for PEP 12,
51+
``python pep2html.py pep-0012.rst``).
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)