Skip to content

Commit 26bb7a3

Browse files
committed
Update documentation
1 parent eb93d85 commit 26bb7a3

9 files changed

Lines changed: 44 additions & 19 deletions

docs/assets/rye-intentions-bump-project-version-demo-major.png renamed to docs/assets/uv-intentions-bump-project-version-demo-major.png

File renamed without changes.

docs/assets/rye-intentions-bump-project-version-demo-minor.png renamed to docs/assets/uv-intentions-bump-project-version-demo-minor.png

File renamed without changes.

docs/assets/rye-intentions-bump-project-version-demo-patch.png renamed to docs/assets/uv-intentions-bump-project-version-demo-patch.png

File renamed without changes.

docs/features.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,7 @@ Examples: [`uv.lock` should not be edited manually][8].
3232
[2]: rye/actions.md#open-configuration-file
3333
[3]: ruff/actions.md#clean-cache
3434
[4]: https://www.jetbrains.com/help/pycharm/intention-actions.html
35-
[5]: rye/intentions.md#bump-project-version
35+
[5]: uv/intentions.md#bump-project-version
3636
[6]: uv/intentions.md#synchronize-project
3737
[7]: https://www.jetbrains.com/help/pycharm/code-inspection.html
3838
[8]: uv/inspections.md#editing-uvlock

docs/rye/intentions.md

Lines changed: 0 additions & 17 deletions
This file was deleted.

docs/ty/actions.md

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
## Show executable
2+
3+
Show the ty executable that would be used for the project,
4+
or, when the action is not triggered in a project context,
5+
the ty executable.
6+
7+
8+
## Show version
9+
10+
Display a message showing the version of the current ty executable.
11+
12+
This is equivalent to running `ty version`.

docs/ty/index.md

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
[ty][1] is a type checker and language server.
2+
3+
RyeCharm only supports running it as a language server.
4+
There is no <i>Command line</i> mode.
5+
The other modes are the same as [that of Ruff][2].
6+
7+
8+
[1]: https://github.com/astral-sh/ty/blob/main/docs/README.md
9+
[2]: ../ruff/running-modes.md

docs/uv/intentions.md

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,22 @@
1+
## Bump project version
2+
3+
The three intentions of this type
4+
(for major, minor and patch bumping types)
5+
are available in a `pyproject.toml` file.
6+
7+
This is equivalent to running `uv version --bump ...` at the project's path.
8+
9+
10+
=== "Major"
11+
![](../assets/uv-intentions-bump-project-version-demo-major.png)
12+
13+
=== "Minor"
14+
![](../assets/uv-intentions-bump-project-version-demo-minor.png)
15+
16+
=== "Patch"
17+
![](../assets/uv-intentions-bump-project-version-demo-patch.png)
18+
19+
120
## Synchronize project
221

322
This intention is available in a `pyproject.toml` file.

mkdocs.yaml

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -87,10 +87,12 @@ nav:
8787
- Inspections: uv/inspections.md
8888
- Run configurations: uv/run-configurations.md
8989
- Documentation: uv/documentation.md
90+
- ty:
91+
- ty integration: ty/index.md
92+
- Actions: ty/actions.md
9093
- Rye:
9194
- Rye integration: rye/index.md
9295
- Actions: rye/actions.md
93-
- Intentions: rye/intentions.md
9496
- Configurations:
9597
- Configurations overview: configurations/index.md
9698
- Ruff: configurations/ruff.md

0 commit comments

Comments
 (0)