From 995307767f5c98be3f0b2f4eccf27d1bfc9af37e Mon Sep 17 00:00:00 2001 From: Zanie Blue Date: Wed, 30 Oct 2024 16:48:34 -0500 Subject: [PATCH] Clarify preview requirement for relevance of `uv python dir --bin` (#8709) --- crates/uv-cli/src/lib.rs | 8 +++----- docs/reference/cli.md | 6 ++---- 2 files changed, 5 insertions(+), 9 deletions(-) diff --git a/crates/uv-cli/src/lib.rs b/crates/uv-cli/src/lib.rs index 63cf40c87..fd05d1ee6 100644 --- a/crates/uv-cli/src/lib.rs +++ b/crates/uv-cli/src/lib.rs @@ -3840,7 +3840,8 @@ pub enum PythonCommand { /// /// The Python installation directory may be overridden with `$UV_PYTHON_INSTALL_DIR`. /// - /// To instead view the directory uv installs Python executables into, use the `--bin` flag. + /// To view the directory where uv installs Python executables instead, use the `--bin` flag. + /// Note that Python executables are only installed when preview mode is enabled. Dir(PythonDirArgs), /// Uninstall Python versions. @@ -3874,10 +3875,7 @@ pub struct PythonListArgs { pub struct PythonDirArgs { /// Show the directory into which `uv python` will install Python executables. /// - /// Note this directory is only used when installing with preview mode enabled. - /// - /// By default, `uv python dir` shows the directory into which the Python distributions - /// themselves are installed, rather than the directory containing the linked executables. + /// Note that this directory is only used when installing Python with preview mode enabled. /// /// The Python executable directory is determined according to the XDG standard and is derived /// from the following environment variables, in order of preference: diff --git a/docs/reference/cli.md b/docs/reference/cli.md index ae89996eb..55e5f2646 100644 --- a/docs/reference/cli.md +++ b/docs/reference/cli.md @@ -4693,7 +4693,7 @@ By default, Python installations are stored in the uv data directory at `$XDG_DA The Python installation directory may be overridden with `$UV_PYTHON_INSTALL_DIR`. -To instead view the directory uv installs Python executables into, use the `--bin` flag. +To view the directory where uv installs Python executables instead, use the `--bin` flag. Note that Python executables are only installed when preview mode is enabled.

Usage

@@ -4705,9 +4705,7 @@ uv python dir [OPTIONS]
--bin

Show the directory into which uv python will install Python executables.

-

Note this directory is only used when installing with preview mode enabled.

- -

By default, uv python dir shows the directory into which the Python distributions themselves are installed, rather than the directory containing the linked executables.

+

Note that this directory is only used when installing Python with preview mode enabled.

The Python executable directory is determined according to the XDG standard and is derived from the following environment variables, in order of preference: