Skip to content

Commit 60df8d8

Browse files
samcunliffeCopilot
andauthored
Some typos spotted by Copilot
Co-authored-by: Copilot <[email protected]>
1 parent d474564 commit 60df8d8

1 file changed

Lines changed: 3 additions & 3 deletions

File tree

tutorial.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -252,7 +252,7 @@ https://{github_owner}.github.io/{project_slug}
252252
🎉
253253

254254
You should see that the homepage of the documentation site is the same as the repository README file.
255-
Importantly, the documentation website inclides the [_application programming interface_ (API](https://en.wikipedia.org/wiki/API) reference documentation.
255+
Importantly, the documentation website includes the [_application programming interface_ (API](https://en.wikipedia.org/wiki/API) reference documentation.
256256
The API documentation is generated from [docstrings](https://peps.python.org/pep-0257/#what-is-a-docstring) in the source code.
257257

258258
## 🐍 Setting up a virtual environment for project
@@ -283,7 +283,7 @@ or on Windows:
283283
.venv\Scripts\activate
284284
```
285285

286-
So activate your environment and you should see braces `( )` with your project slug on the left of your terminal window.
286+
Activate your environment, and you should see braces `( )` with your project slug on the left of your terminal window.
287287
This might be slightly different depending on your terminal setup.
288288

289289
Once you have activated the environment you can use the following command to install any packages within the `.venv` environment
@@ -379,7 +379,7 @@ It's sometimes useful to be able to render the HTML documentation pages locally.
379379
For example if you're editing docstrings or adding additional pages, and you want to check everything worked.
380380
The package is set up to use [MkDocs](https://www.mkdocs.org/) to build the documentation website.
381381
The API documentation is generated using the [`mkdocstrings` plug-in](https://mkdocstrings.github.io/).
382-
Mkdocks and `mkdocstrings` will have been installed in your local development environment, because you installed the package with the `docs` dependencies.
382+
MkDocs and `mkdocstrings` will have been installed in your local development environment, because you installed the package with the `docs` dependencies.
383383

384384
To build and serve the documentation locally run:
385385

0 commit comments

Comments
 (0)