Skip to content

Commit 9621fb1

Browse files
authored
Merge pull request #918 from ebouchut/ebouchut/fix/typo_in_readme
✏ Fix typos in README
2 parents 38f6a83 + b278312 commit 9621fb1

File tree

1 file changed

+9
-6
lines changed

1 file changed

+9
-6
lines changed

README.md

Lines changed: 9 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -565,9 +565,9 @@ where:
565565
- `.copy` shows the copy-to-clipboard button when present (hidden otherwise)
566566
- `title=“title of this code block”` adds a title to the code (none when absent)
567567
568-
Do note that:
569-
- There is a space before **and** after the opening curly brace ` { `.
570-
- There is space before the closing curly brace `}`.
568+
> [!NOTE]
569+
> - There is a space **before and after** the **opening** curly brace ` { `.
570+
> - There is space **before** the **closing** curly brace `}`.
571571
572572
573573
[Source](https://squidfunk.github.io/mkdocs-material/reference/code-blocks/?h=copy+clipboard#code-copy-button)
@@ -615,11 +615,14 @@ The website uses the Markdown page of the glossary.
615615
### Add a Package
616616
617617
> [!NOTE]
618-
> In this section, the terms Python **package** and **dependency** refer to the same thing.
618+
> In this section:
619+
>
620+
> - the terms Python **package** and **dependency** refer to the same thing.
621+
> - `XXX` denotes the name of the package to add
619622
620623
- **Create** a feature **branch** (aka. topic branch)
621624
```shell
622-
git switch dev
625+
git switch main
623626
git switch -c feature/add_dependency_XXX
624627
```
625628
- **Add** the pinned version of the new **package** to the **`requirements.in`** file
@@ -648,7 +651,7 @@ The website uses the Markdown page of the glossary.
648651
pip install -r dev-requirements.txt
649652
650653
# Install the direct dependencies (listed in `requirements.in`
651-
# This also installs the indirect dependencies these packages depend upon.
654+
# This also installs the indirect dependencies that these packages depend upon.
652655
pip install -r requirements.in
653656
654657
# Add code/doc using this package and test until it is ready.

0 commit comments

Comments
 (0)