From 7c0b08c1abb7d6e83a08e1b8cbe6ad4d171ced83 Mon Sep 17 00:00:00 2001 From: Zanie Blue Date: Mon, 28 Jul 2025 11:45:41 -0500 Subject: [PATCH] Update doc --- crates/uv-settings/src/settings.rs | 16 ++++++++-------- crates/uv-workspace/src/pyproject.rs | 8 ++++---- docs/reference/settings.md | 24 ++++++++++++------------ uv.schema.json | 4 ++-- 4 files changed, 26 insertions(+), 26 deletions(-) diff --git a/crates/uv-settings/src/settings.rs b/crates/uv-settings/src/settings.rs index 23b11e87b..aa9243f24 100644 --- a/crates/uv-settings/src/settings.rs +++ b/crates/uv-settings/src/settings.rs @@ -625,11 +625,11 @@ pub struct ResolverInstallerOptions { "# )] pub no_build_isolation_package: Option>, - /// Additional build dependencies for dependencies. + /// Additional build dependencies for packages. /// - /// This is intended for enabling more packages to be built with - /// build-isolation, by adding dependencies that they ambiently - /// assume to exist (`setuptools` and `pip` being common). + /// This allows extending the PEP 517 build environment for the project's dependencies with + /// additional packages. This is useful for packages that assume the presence of packages, like, + /// `pip`, and do not declare them as build dependencies. #[option( default = "[]", value_type = "dict", @@ -1135,11 +1135,11 @@ pub struct PipOptions { "# )] pub no_build_isolation_package: Option>, - /// Additional build dependencies for dependencies. + /// Additional build dependencies for packages. /// - /// This is intended for enabling more packages to be built with - /// build-isolation, by adding dependencies that they ambiently - /// assume to exist (`setuptools` and `pip` being common). + /// This allows extending the PEP 517 build environment for the project's dependencies with + /// additional packages. This is useful for packages that assume the presence of packages, like, + /// `pip`, and do not declare them as build dependencies. #[option( default = "[]", value_type = "dict", diff --git a/crates/uv-workspace/src/pyproject.rs b/crates/uv-workspace/src/pyproject.rs index d04c87efb..4a1c9231c 100644 --- a/crates/uv-workspace/src/pyproject.rs +++ b/crates/uv-workspace/src/pyproject.rs @@ -378,11 +378,11 @@ pub struct ToolUv { )] pub dependency_groups: Option, - /// Additional build dependencies for dependencies. + /// Additional build dependencies for packages. /// - /// This is intended for enabling more packages to be built with - /// build-isolation, by adding dependencies that they ambiently - /// assume to exist (`setuptools` and `pip` being common). + /// This allows extending the PEP 517 build environment for the project's dependencies with + /// additional packages. This is useful for packages that assume the presence of packages, like, + /// `pip`, and do not declare them as build dependencies. #[option( default = "[]", value_type = "dict", diff --git a/docs/reference/settings.md b/docs/reference/settings.md index 3cca74d95..ebb3bc958 100644 --- a/docs/reference/settings.md +++ b/docs/reference/settings.md @@ -204,11 +204,11 @@ environments = ["sys_platform == 'darwin'"] ### [`extra-build-dependencies`](#extra-build-dependencies) {: #extra-build-dependencies } -Additional build dependencies for dependencies. +Additional build dependencies for packages. -This is intended for enabling more packages to be built with -build-isolation, by adding dependencies that they ambiently -assume to exist (`setuptools` and `pip` being common). +This allows extending the PEP 517 build environment for the project's dependencies with +additional packages. This is useful for packages that assume the presence of packages, like, +`pip`, and do not declare them as build dependencies. **Default value**: `[]` @@ -1125,11 +1125,11 @@ behave consistently across timezones. ### [`extra-build-dependencies`](#extra-build-dependencies) {: #extra-build-dependencies } -Additional build dependencies for dependencies. +Additional build dependencies for packages. -This is intended for enabling more packages to be built with -build-isolation, by adding dependencies that they ambiently -assume to exist (`setuptools` and `pip` being common). +This allows extending the PEP 517 build environment for the project's dependencies with +additional packages. This is useful for packages that assume the presence of packages, like, +`pip`, and do not declare them as build dependencies. **Default value**: `[]` @@ -2617,11 +2617,11 @@ Only applies to `pyproject.toml`, `setup.py`, and `setup.cfg` sources. #### [`extra-build-dependencies`](#pip_extra-build-dependencies) {: #pip_extra-build-dependencies } -Additional build dependencies for dependencies. +Additional build dependencies for packages. -This is intended for enabling more packages to be built with -build-isolation, by adding dependencies that they ambiently -assume to exist (`setuptools` and `pip` being common). +This allows extending the PEP 517 build environment for the project's dependencies with +additional packages. This is useful for packages that assume the presence of packages, like, +`pip`, and do not declare them as build dependencies. **Default value**: `[]` diff --git a/uv.schema.json b/uv.schema.json index eaf8d4104..619e8dff3 100644 --- a/uv.schema.json +++ b/uv.schema.json @@ -215,7 +215,7 @@ ] }, "extra-build-dependencies": { - "description": "Additional build dependencies for dependencies.\n\nThis is intended for enabling more packages to be built with\nbuild-isolation, by adding dependencies that they ambiently\nassume to exist (`setuptools` and `pip` being common).", + "description": "Additional build dependencies for packages.\n\nThis allows extending the PEP 517 build environment for the project's dependencies with\nadditional packages. This is useful for packages that assume the presence of packages, like,\n`pip`, and do not declare them as build dependencies.", "anyOf": [ { "$ref": "#/definitions/ToolUvExtraBuildDependencies" @@ -1299,7 +1299,7 @@ } }, "extra-build-dependencies": { - "description": "Additional build dependencies for dependencies.\n\nThis is intended for enabling more packages to be built with\nbuild-isolation, by adding dependencies that they ambiently\nassume to exist (`setuptools` and `pip` being common).", + "description": "Additional build dependencies for packages.\n\nThis allows extending the PEP 517 build environment for the project's dependencies with\nadditional packages. This is useful for packages that assume the presence of packages, like,\n`pip`, and do not declare them as build dependencies.", "type": [ "object", "null"