Skip to content

Commit a22ef67

Browse files
committed
Update docs
1 parent c956a4e commit a22ef67

3 files changed

Lines changed: 7 additions & 6 deletions

File tree

docs/pages/libraries/jupyter-notebooks.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,7 @@ more reliably than [black] via [nbQA].
3232
| Name | Short description | 🚦 |
3333
| ---------------- | -------------------------------------------------------------------------------- | :------------------------------------------: |
3434
| `black[jupyter]` | (also `black-jupyter`) [black] with the optional Jupyter extension. | <span class="label label-green">Best</span> |
35-
| [nbQA] | Recommended for all other linters ([ruff], [isort]) and [mypy]. | <span class="label label-green">Best</span> |
35+
| [nbQA] | Recommended for all other linters ([ruff], [isort]) and [ty]. | <span class="label label-green">Best</span> |
3636
| [pre-commit] | Has cell output cleanup hooks (if desired). Also found to work well with [nbQA]. | <span class="label label-green">Best</span> |
3737
| `nbqa black` | [black] via [nbQA]. | <span class="label label-yellow">Good</span> |
3838

@@ -48,7 +48,7 @@ more reliably than [black] via [nbQA].
4848
[nbQA]: https://nbqa.readthedocs.io/en/latest/index.html
4949
[isort]: https://pycqa.github.io/isort
5050
[ruff]: https://github.com/charliermarsh/ruff
51-
[mypy]: https://mypy.readthedocs.io/en/stable
51+
[ty]: https://docs.astral.sh/ty/
5252
[pre-commit]: https://github.com/kynan/nbstripout
5353
[jupytext]: https://jupytext.readthedocs.io/en/stable/
5454

docs/pages/linting.md

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -29,9 +29,10 @@ for some of these.
2929

3030
### Type checking
3131

32-
| Name | Short description | 🚦 |
33-
| ---------------------------------------------- | ----------------------------------------------------------------------------- | :-----------------------------------------: |
34-
| [mypy](https://mypy.readthedocs.io/en/stable/) | Static type checker, won't fail if no typing but will if typing is incorrect. | <span class="label label-green">Best</span> |
32+
| Name | Short description | 🚦 |
33+
| ---------------------------------------------- | ----------------------------------------------------------------------------- | :------------------------------------------: |
34+
| [ty](https://docs.astral.sh/ty/) | Static type checker, fast and rapidly developing. | <span class="label label-green">Best</span> |
35+
| [mypy](https://mypy.readthedocs.io/en/stable/) | Static type checker, won't fail if no typing but will if typing is incorrect. | <span class="label label-yellow">Good</span> |
3536

3637
### Dependency checking
3738

docs/pages/tutorial.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -403,7 +403,7 @@ The package is set-up to use [pre-commit](https://pre-commit.com/), a framework
403403
There is a `.pre-commit-config.yaml` configuration file which you can take a look at.
404404
With this setup `pre-commit` will run a series of fast linters, checks and formatters on the repository on every commit.
405405

406-
The main tools we recommend are [ruff](https://docs.astral.sh/ruff/), [mypy](https://mypy.readthedocs.io/en/stable/) and [prettier](https://prettier.io/).
406+
The main tools we recommend are [ruff](https://docs.astral.sh/ruff/), [ty](https://docs.astral.sh/ty/) and [prettier](https://prettier.io/).
407407
These Git hook scripts can installed locally by running
408408

409409
```sh

0 commit comments

Comments
 (0)