Skip to content
This repository was archived by the owner on Mar 13, 2024. It is now read-only.

Commit 901f505

Browse files
committed
Update docs
1 parent c002511 commit 901f505

File tree

3 files changed

+17
-2
lines changed

3 files changed

+17
-2
lines changed

docs/explanations/why-pre-commit.rst

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -39,7 +39,11 @@ If using VSCode, this will still run black, flake8 and mypy on file save, but
3939
for those using other editors and for CI another solution was needed. Enter
4040
`pre-commit <https://pre-commit.com/>`_. This allows hooks to be run at ``git
4141
commit`` time on just the files that have changed, as well as on all tracked
42-
files by CI. The graph now looks like:
42+
files by CI. All that is needed is a one time install of the git commit hook::
43+
44+
$ pipenv run pre-commit install
45+
46+
The graph now looks like:
4347

4448
- pytest
4549
- pre-commit
@@ -56,4 +60,3 @@ Now the workflow looks like this:
5660
- Commit files and pre-commit runs black, flake8 and mypy on them
5761
- Push to remote and CI runs black, flake8, mypy once on all files, then pytest
5862
multiple times in a test matrix
59-

docs/how-to/existing.rst

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -16,6 +16,12 @@ This will:
1616
- Push that merge branch back to the existing repo
1717
- Merge with the currently checked out branch, leaving you to fix the conflicts
1818

19+
.. note::
20+
21+
If you installed the commandline tool in a virtualenv, be sure to run
22+
``deactivate`` when you have finished running it, otherwise ``pipenv
23+
install`` will use your virtualenv rather than making its own
24+
1925
Example merge
2026
-------------
2127

docs/tutorials/new.rst

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,12 @@ This will:
1313
- Create a new repo at the requested path, forked from the skeleton repo
1414
- Create a single commit that modifies the skeleton with the repo and package name
1515

16+
.. note::
17+
18+
If you installed the commandline tool in a virtualenv, be sure to run
19+
``deactivate`` when you have finished running it, otherwise ``pipenv
20+
install`` will use your virtualenv rather than making its own
21+
1622
Getting started with your new repo
1723
----------------------------------
1824

0 commit comments

Comments
 (0)