Skip to content

Commit 3c336f4

Browse files
authored
Fix minor punctuation and formatting issues
2 parents aadb87d + 2558780 commit 3c336f4

File tree

1 file changed

+8
-8
lines changed

1 file changed

+8
-8
lines changed

tutorials/create-python-package.md

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -85,7 +85,7 @@ Please select the type of template that you want to create today."
8585
pyopensci
8686

8787
```
88-
The template will then begin to copy files into the directory that used above. (`.` means current working directory
88+
The template will then begin to copy files into the directory that used above. (`.` means current working directory.)
8989

9090
```console
9191
...Copying from template version 0.6.4.1
@@ -112,10 +112,10 @@ The final package structure will look like this:
112112
:animate: fade-in-slide-down
113113

114114
If you use the "bells and whistles" default option when working through the template prompts,
115-
our template will create a complete package setup with GitHub CI actions, typing, tests, environments
116-
, and more using Hatch. If you customize the entire package, then you can select what platform you wish to host it on (GitHub vs GitLab), whether you want typing, what documentation engine you want to use, and more.
115+
our template will create a complete package setup with GitHub CI actions, typing, tests, environments,
116+
and more using Hatch. If you customize the entire package, then you can select what platform you wish to host it on (GitHub vs GitLab), whether you want typing, what documentation engine you want to use, and more.
117117

118-
The resulting package directory looks like this
118+
The resulting package directory looks like this:
119119

120120
```console
121121
├── CHANGELOG.md
@@ -140,14 +140,14 @@ The resulting package directory looks like this
140140

141141
The default tools that your package uses are:
142142

143-
* [Sphinx](https://www.pyopensci.org/python-package-guide/documentation/hosting-tools/sphinx-python-package-documentation-tools.html) with the pydata_sphinx_theme for documentation
143+
* [Sphinx](https://www.pyopensci.org/python-package-guide/documentation/hosting-tools/sphinx-python-package-documentation-tools.html) with the PyData Sphinx Theme for documentation
144144
* pytest for testing
145145
* Hatch for environment setup
146146

147147
**Full customization**
148148
If you want to customize any elements of your package setup, choose `No, I want to fully customize the template.`. This will allow you to select:
149149

150-
* sphinx vs [mkdocs](https://www.mkdocs.org/) vs no documentation
150+
* Sphinx vs [MkDocs](https://www.mkdocs.org/) vs no documentation
151151
* GitHub vs GitLab
152152
* VCS versioning
153153
* and more
@@ -219,7 +219,7 @@ A `pyproject.toml` file stores metadata that provides instructions to various to
219219
You will learn more about the `pyproject.toml` format in the
220220
[next lesson when you add additional metadata/information to this file.](pyproject-toml.md)
221221

222-
The metadata in your generated pyproject.toml is already setup for you using the information you provided the copier template above.
222+
The metadata in your generated `pyproject.toml` is already setup for you using the information you provided the copier template above.
223223

224224
:::{admonition} Brief overview of the TOML file
225225
:class: tip
@@ -232,7 +232,7 @@ Tables can contain variables within them defined by a variable name and an `=` s
232232
For instance, a `build-system` table most often holds two (2) variables:
233233

234234
1. `requires = `, which tells a build tool what tools it needs to install prior to building your package. In this case
235-
[hatchling](https://pypi.org/project/hatchling/)
235+
[hatchling](https://pypi.org/project/hatchling/).
236236
2. `build-backend = `, which is used to define the specific build-backend name, (in this example we are using `hatchling.build`).
237237

238238
```toml

0 commit comments

Comments
 (0)