From b826dc445162af7d6edd1aebe173fa49c1d683ce Mon Sep 17 00:00:00 2001 From: Sofie Van Landeghem Date: Wed, 4 Dec 2024 18:06:40 +0100 Subject: [PATCH] =?UTF-8?q?=E2=9C=8F=EF=B8=8F=20Fix=20a=20few=20small=20ty?= =?UTF-8?q?pos=20in=20the=20documentation=20(#1077)?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- docs/contributing.md | 6 +++--- docs/tutorial/options-autocompletion.md | 2 +- 2 files changed, 4 insertions(+), 4 deletions(-) diff --git a/docs/contributing.md b/docs/contributing.md index 7600780afe..d7b7f53c8c 100644 --- a/docs/contributing.md +++ b/docs/contributing.md @@ -74,7 +74,7 @@ This command generates a directory `./htmlcov/`, if you open the file `./htmlcov To try and test the completion for different shells and check that they are working you can use a Docker container. -There's a `Dockerfile` and a a Docker Compose file `compose.yaml` at `./scripts/docker/`. +There's a `Dockerfile` and a Docker Compose file `compose.yaml` at `./scripts/docker/`. It has installed `bash`, `zsh`, `fish`, and `pwsh` (PowerShell for Linux). @@ -237,9 +237,9 @@ That way, you can edit the documentation/source files and see the changes live. /// tip -Alternatively, you can perform the same steps that scripts does manually. +Alternatively, you can perform the same steps that script does manually. -Go into the docs director at `docs/`: +Go into the docs directory at `docs/`: ```console $ cd docs/ diff --git a/docs/tutorial/options-autocompletion.md b/docs/tutorial/options-autocompletion.md index fdfc875f7c..f4c47e4efe 100644 --- a/docs/tutorial/options-autocompletion.md +++ b/docs/tutorial/options-autocompletion.md @@ -14,7 +14,7 @@ After installing completion for your own Python package (or using the `typer` co To check it quickly without creating a new Python package, use the `typer` command. -Then let's create small example program: +Then let's create a small example program: {* docs_src/options_autocompletion/tutorial001_an.py *}