Skip to content

Commit b72b66b

Browse files
committed
Address review
1 parent 68faf73 commit b72b66b

File tree

1 file changed

+9
-7
lines changed

1 file changed

+9
-7
lines changed

pages/developers/gha_basic.md

Lines changed: 9 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -41,7 +41,7 @@ you use a develop branch, you probably will want to include that.
4141
4242
## Pre-commit
4343
44-
If you use pre-commit (and you should), this is a job that will check pre-commit for you:
44+
If you use [pre-commit](https://pre-commit.com) (and you should), this is a job that will check pre-commit for you:
4545
4646
```yaml
4747
pre-commit:
@@ -63,7 +63,8 @@ If you use pre-commit (and you should), this is a job that will check pre-commit
6363
6464
Implementing unit tests is also easy. Since you should be following best
6565
practices listed in the previous sections, this becomes an almost directly
66-
copy-and-paste formula, regardless of the package details.
66+
copy-and-paste formula, regardless of the package details. You might need
67+
to adjust the Python versions to suit your taste.
6768
6869
```yaml
6970
checks:
@@ -99,8 +100,9 @@ You need to use version 1 of the checkout, since version 2 strips too much
99100
from the repository for `setuptools_scm` to work.
100101

101102
The formula here for installing should be identical for all users; and using
102-
PEP 517/518 builds, you are even guaranteed a consistent wheel will be produced
103-
just as if you were building a final package.
103+
[PEP 517](https://www.python.org/dev/peps/pep-0517/)/[518](https://www.python.org/dev/peps/pep-0518/)
104+
builds, you are even guaranteed a consistent wheel will be produced just as if
105+
you were building a final package.
104106

105107
## Distribution: Pure Python wheels
106108

@@ -116,10 +118,10 @@ package, the procedure is simple.
116118
with:
117119
python-version: 3.8
118120
119-
- name: Install wheel and sdist requirements
121+
- name: Install wheel and SDist requirements
120122
run: python -m pip install "setuptools>=42.0" "setuptools_scm[toml]>=3.4" "wheel"
121123
122-
- name: Build sdist
124+
- name: Build SDist
123125
run: python setup.py sdist
124126
125127
- name: Build wheel
@@ -146,7 +148,7 @@ A few things to note that are new to this job:
146148
We install SDist requirements by hand since `python setup.py sdist` does not
147149
get the benefits of having pip install things. If you have any special
148150
requirements in your `pyproject.toml`, you'll need to list them here. This is
149-
special just for the sdist, not for making wheels (which should be done by the
151+
special just for the SDist, not for making wheels (which should be done by the
150152
PEP 517/518 process for you).
151153

152154
You need to put your base package name in for `<packagename>` in the copy

0 commit comments

Comments
 (0)