@@ -565,9 +565,9 @@ where:
565
565
- ` .copy` shows the copy-to-clipboard button when present (hidden otherwise)
566
566
- ` title=“title of this code block”` adds a title to the code (none when absent)
567
567
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 ` }` .
571
571
572
572
573
573
[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.
615
615
### Add a Package
616
616
617
617
> [!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
619
622
620
623
- **Create** a feature **branch** (aka. topic branch)
621
624
```shell
622
- git switch dev
625
+ git switch main
623
626
git switch -c feature/add_dependency_XXX
624
627
```
625
628
- **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.
648
651
pip install -r dev-requirements.txt
649
652
650
653
# 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.
652
655
pip install -r requirements.in
653
656
654
657
# Add code/doc using this package and test until it is ready.
0 commit comments