Skip to content

Commit c89d0f2

Browse files
authored
docs(contributors): use admonitions consistently (#16)
1 parent 2233106 commit c89d0f2

File tree

2 files changed

+27
-19
lines changed

2 files changed

+27
-19
lines changed

.gitignore

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1,2 @@
1-
/site
1+
site/
2+
_site/

docs/guides/guide-contributor/language-specific/python.md

Lines changed: 25 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -25,20 +25,22 @@ to ease maintenance. If using Poetry (see below), you can use the
2525
[`poetry-sort`][py-poetry-sort] plugin to help with this. Otherwise any other
2626
TOML sorter should work as well.
2727

28-
> **Note**: We strongly recommend using the [Poetry][py-poetry] package manager
29-
> instead of `pip`. In that case, use `poetry.lock` to lock the dependencies
30-
> (make > sure to commit the file to version control). To add a new dependency,
31-
> use the following command:
32-
>
33-
> ```python
34-
> poetry add <package> --group=<group>
35-
> ```
36-
>
37-
> To build the project, use:
38-
>
39-
> ```python
40-
> poetry build
41-
> ```
28+
!!! note "Poetry"
29+
30+
We strongly recommend using the [Poetry][py-poetry] package manager instead
31+
of `pip`. In that case, use `poetry.lock` to lock the dependencies (make
32+
sure to commit the file to version control). To add a new dependency, use
33+
the following command:
34+
35+
```python
36+
poetry add <package> --group=<group>
37+
```
38+
39+
To build the project, use:
40+
41+
```python
42+
poetry build
43+
```
4244

4345
### Console scripts
4446

@@ -72,8 +74,10 @@ select = [
7274
]
7375
```
7476

75-
> **Note**: You can fix lints by running `ruff check --fix <Path>` and `ruff
76-
> format <Path>` to format the code.
77+
!!! note "Ruff usage"
78+
79+
You can fix lints by running `ruff check --fix /src/my_module.py` and
80+
`ruff format /src/my_module.py` to format the code.
7781

7882
### Docstrings
7983

@@ -105,8 +109,11 @@ types aren't obvious from assignments.
105109

106110
Adding type hints to (unit) tests is not necessary.
107111

108-
> **Note**: You can try using [MonkeyType][py-monkey-type] to help with adding
109-
> type hints to your code.
112+
!!! note "Automating type hinting"
113+
114+
You can try using [MonkeyType][py-monkey-type] to help with adding type
115+
hints to your code.
116+
110117

111118
### Static type checkers
112119

0 commit comments

Comments
 (0)