Skip to content

Commit 64a5ce1

Browse files
committed
🐛 hatch explanation
1 parent 121363d commit 64a5ce1

File tree

4 files changed

+23
-4
lines changed

4 files changed

+23
-4
lines changed

README.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -83,7 +83,7 @@ hatch run docs:serve
8383
```
8484

8585
Once the server is running, you can view the documentation at
86-
[localhost:8080/contributing].
86+
[localhost:8080/contributing] or see a preview at [juftin.com/cookiecutter-python/contributing].
8787

8888
[pre-commit]: https://pre-commit.com/
8989
[gitmoji]: https://gitmoji.dev/
@@ -103,3 +103,4 @@ Once the server is running, you can view the documentation at
103103
[localhost:8080/contributing]: http://localhost:8080/contributing
104104
[ruff]: https://docs.astral.sh/ruff/
105105
[mypy]: https://mypy.readthedocs.io/
106+
[juftin.com/cookiecutter-python/contributing]: https://juftin.com/cookiecutter-python/contributing/

docs/contributing.md

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -54,13 +54,19 @@
5454
5555
### Hatch Explanation
5656
57+
Hatch is a Python package manager. It's most basic use is as a standardized build-system.
58+
However, hatch also has some extra features which this project takes advantage of.
59+
These features include virtual environment management and the organization of common
60+
scripts like linting and testing. All the operations in hatch take place in one
61+
of its managed virtual environments.
62+
5763
Hatch has a variety of environments, to see them simply ask hatch:
5864

5965
```bash exec="on" result="markdown" source="tabbed-left" tabs="hatch CLI|Output"
6066
hatch env show
6167
```
6268

63-
That above command will tell you that there are five environments that
69+
That above command will tell you that there are four environments that
6470
you can use:
6571

6672
- `default`

tests/example-project/docs/contributing.md

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -54,13 +54,19 @@
5454
5555
### Hatch Explanation
5656
57+
Hatch is a Python package manager. It's most basic use is as a standardized build-system.
58+
However, hatch also has some extra features which this project takes advantage of.
59+
These features include virtual environment management and the organization of common
60+
scripts like linting and testing. All the operations in hatch take place in one
61+
of its managed virtual environments.
62+
5763
Hatch has a variety of environments, to see them simply ask hatch:
5864

5965
```bash exec="on" result="markdown" source="tabbed-left" tabs="hatch CLI|Output"
6066
hatch env show
6167
```
6268

63-
That above command will tell you that there are five environments that
69+
That above command will tell you that there are four environments that
6470
you can use:
6571

6672
- `default`

{{cookiecutter.repo_name}}/docs/contributing.md

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -54,13 +54,19 @@
5454
5555
### Hatch Explanation
5656
57+
Hatch is a Python package manager. It's most basic use is as a standardized build-system.
58+
However, hatch also has some extra features which this project takes advantage of.
59+
These features include virtual environment management and the organization of common
60+
scripts like linting and testing. All the operations in hatch take place in one
61+
of its managed virtual environments.
62+
5763
Hatch has a variety of environments, to see them simply ask hatch:
5864

5965
```bash exec="on" result="markdown" source="tabbed-left" tabs="hatch CLI|Output"
6066
hatch env show
6167
```
6268

63-
That above command will tell you that there are five environments that
69+
That above command will tell you that there are four environments that
6470
you can use:
6571

6672
- `default`

0 commit comments

Comments
 (0)