Skip to content

Commit 4e1d595

Browse files
committed
Fix: Edits from review
1 parent 4eb21e5 commit 4e1d595

File tree

2 files changed

+11
-6
lines changed

2 files changed

+11
-6
lines changed

tutorials/1-installable-code.md

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -156,8 +156,10 @@ Below you will create a directory structure similar to the structure described a
156156
## Step 1: Set Up the Package Directory Structure
157157

158158
* Open your shell or preferred terminal.
159-
* cd to the location where you'd like your package directory to live. Hatch will create the package directory for you
160-
* Choose a name for your package, preferably in lowercase and without spaces. For this tutorial we'll use `pyospackage`.
159+
* Use the shell `cd` command to navigate in your shell to the location where you'd like your package directory to live. Hatch will create the package directory for you
160+
* Choose a name for your package. The name should:
161+
* Have no spaces (*Required*)
162+
* Use all lowercase characters (*Recommended*). For this tutorial we will use `pyospackage`.
161163

162164
Next run:
163165

@@ -293,7 +295,7 @@ You will learn more about the `pyproject.toml` format in the
293295
[next lesson when you add additional metadata / information to this file.](5-pyproject-toml.md)
294296
:::
295297

296-
- Open up the `pyproject.toml` file that Hatch created in your favorite text editor. Is should look something like the example below.
298+
- Open up the `pyproject.toml` file that Hatch created in your favorite text editor. It should look something like the example below.
297299

298300

299301
```toml

tutorials/get-to-know-hatch.md

Lines changed: 6 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ If you are comfortable using [pipx](https://pipx.pypa.io/stable/) to install hat
1313
However if you are not sure about pipx, you can install hatch using pip or conda.
1414
:::
1515

16-
### Configure hatch
16+
## Configure hatch
1717

1818
Once you have installed hatch, you will want to customize the configuration.
1919

@@ -44,7 +44,10 @@ email = "[email protected]"
4444

4545
Next, set tests to false in the `[template.plugins.default]` table.
4646

47-
While tests are important, setting tests to true will create a more complex pyproject.toml file. That we won't need to use in this beginner friendly tutorial series.
47+
While tests are important, setting the tests configuration in Hatch
48+
to `true` will create a more complex pyproject.toml file. You won't
49+
need to use this feature in this beginner friendly tutorial series
50+
but we will introduce it in later tutorials.
4851

4952
Your config.toml file should look something like the one below. It's ok if you have
5053

@@ -114,7 +117,7 @@ and maintaining your Python package easier.
114117

115118
A few features that hatch offers
116119

117-
1. it will convert metadata stored in a setup.py or setup.cfg file to a pyproject.toml file for you. While we haove not extensively tested this feature yet, please let us know if you try it!
120+
1. it will convert metadata stored in a setup.py or setup.cfg file to a pyproject.toml file for you. While we have not extensively tested this feature yet, please let us know if you try it!
118121
2. It will help you by storing configuration information for publishing to PyPI after you've entered it once.
119122

120123
Use `hatch -h` to see all of the available commands.

0 commit comments

Comments
 (0)