Add document for specifying Python interpreter in tool installation and upgrade commands. #11598
Conversation
…nd upgrade commands. Signed-off-by: FishAlchemist <48265002+FishAlchemist@users.noreply.github.com>
docs/guides/tools.md
Outdated
| You can specify the Python interpreter to use with the `--python` option: | ||
|
|
||
| ```console | ||
| $ uv tool install ruff --python=3.10 | ||
| ``` |
There was a problem hiding this comment.
Could we move these into a dedicated section instead? We're explaining what tool installations are here — it seems distracting to jump to this.
In the guide, I'd put a ## Requesting Python versions section after installing or upgrading tools?
I think there should also be a ## Python versions section in the tool concept page?
There was a problem hiding this comment.
Could we move these into a dedicated section instead? We're explaining what tool installations are here — it seems distracting to jump to this.
In the guide, I'd put a ## Requesting Python versions section after installing or upgrading tools?
Yes, but should I put two commands (install and upgrade), or just put the install command?
I think there should also be a ## Python versions section in the tool concept page?
Yes, it can be added, but perhaps it's only necessary to mention the minor differences and then point to https://docs.astral.sh/uv/concepts/python-versions/ .
There was a problem hiding this comment.
I think it'd be reasonable to be like..
To request a specific Python version for the tool installation:
...
To change the Python version of an existing tool during upgrade:
....
There was a problem hiding this comment.
(and yeah linking to the Python versions concept page seems correct)
There was a problem hiding this comment.
Regarding the concept, to avoid misunderstanding it, I will refrain from modifying it for now. However, I have linked the guides to it.
…ion. Signed-off-by: FishAlchemist <48265002+FishAlchemist@users.noreply.github.com> Signed-off-by: FishAlchemist <48265002+FishAlchemist@users.noreply.github.com>
FishAlchemist
force-pushed
the
tool_specifying_python
branch
from
d4515dd to
bb5ab6d
Compare
Signed-off-by: FishAlchemist <48265002+FishAlchemist@users.noreply.github.com>
Signed-off-by: FishAlchemist <48265002+FishAlchemist@users.noreply.github.com>
Summary
Just to add the section for installing and upgrading uv tool, specifying the Python version, in the document.
Originally, it was planned to add a markdown block (header) for representation, but it was felt to be a bit redundant, so it ended up being like this.
close #11536
Test Plan
Run doc server with strict mode in local. (
mkdocs serve -f mkdocs.public.yml --strict)