Skip to content

Commit

Permalink
docs(contributors): use admonitions consistently (#16)
Browse files Browse the repository at this point in the history
  • Loading branch information
uniqueg authored Jun 20, 2024
1 parent 2233106 commit c89d0f2
Show file tree
Hide file tree
Showing 2 changed files with 27 additions and 19 deletions.
3 changes: 2 additions & 1 deletion .gitignore
Original file line number Diff line number Diff line change
@@ -1 +1,2 @@
/site
site/
_site/
43 changes: 25 additions & 18 deletions docs/guides/guide-contributor/language-specific/python.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,20 +25,22 @@ to ease maintenance. If using Poetry (see below), you can use the
[`poetry-sort`][py-poetry-sort] plugin to help with this. Otherwise any other
TOML sorter should work as well.

> **Note**: We strongly recommend using the [Poetry][py-poetry] package manager
> instead of `pip`. In that case, use `poetry.lock` to lock the dependencies
> (make > sure to commit the file to version control). To add a new dependency,
> use the following command:
>
> ```python
> poetry add <package> --group=<group>
> ```
>
> To build the project, use:
>
> ```python
> poetry build
> ```
!!! note "Poetry"

We strongly recommend using the [Poetry][py-poetry] package manager instead
of `pip`. In that case, use `poetry.lock` to lock the dependencies (make
sure to commit the file to version control). To add a new dependency, use
the following command:

```python
poetry add <package> --group=<group>
```

To build the project, use:

```python
poetry build
```

### Console scripts

Expand Down Expand Up @@ -72,8 +74,10 @@ select = [
]
```

> **Note**: You can fix lints by running `ruff check --fix <Path>` and `ruff
> format <Path>` to format the code.
!!! note "Ruff usage"

You can fix lints by running `ruff check --fix /src/my_module.py` and
`ruff format /src/my_module.py` to format the code.

### Docstrings

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

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

> **Note**: You can try using [MonkeyType][py-monkey-type] to help with adding
> type hints to your code.
!!! note "Automating type hinting"

You can try using [MonkeyType][py-monkey-type] to help with adding type
hints to your code.


### Static type checkers

Expand Down

0 comments on commit c89d0f2

Please sign in to comment.