From 3b595156141bcfb17d2303cb17a714e3cf843ce3 Mon Sep 17 00:00:00 2001 From: Elijah Hartvigsen <35054042+Zij-IT@users.noreply.github.com> Date: Thu, 24 Jul 2025 11:55:14 +0200 Subject: [PATCH] Fix typos in uv_build reference documentation (#14853) ## Summary Fixes both typos mentioned in #14845. ## Test Plan It wasn't :D --------- Co-authored-by: konstin --- crates/uv-build-backend/src/settings.rs | 4 ++-- docs/reference/settings.md | 4 ++-- uv.schema.json | 2 +- 3 files changed, 5 insertions(+), 5 deletions(-) diff --git a/crates/uv-build-backend/src/settings.rs b/crates/uv-build-backend/src/settings.rs index 9e9e44961..33e6d8c45 100644 --- a/crates/uv-build-backend/src/settings.rs +++ b/crates/uv-build-backend/src/settings.rs @@ -155,7 +155,7 @@ pub struct BuildBackendSettings { /// with this package as build requirement use the include directory to find additional header /// files. /// - `purelib` and `platlib`: Installed to the `site-packages` directory. It is not recommended - /// to uses these two options. + /// to use these two options. // TODO(konsti): We should show a flat example instead. // ```toml // [tool.uv.build-backend.data] @@ -165,7 +165,7 @@ pub struct BuildBackendSettings { #[option( default = r#"{}"#, value_type = "dict[str, str]", - example = r#"data = { "headers": "include/headers", "scripts": "bin" }"# + example = r#"data = { headers = "include/headers", scripts = "bin" }"# )] pub data: WheelDataIncludes, } diff --git a/docs/reference/settings.md b/docs/reference/settings.md index 55d3f8ae4..6469a584b 100644 --- a/docs/reference/settings.md +++ b/docs/reference/settings.md @@ -425,7 +425,7 @@ data files are included by placing them in the Python module instead of using da with this package as build requirement use the include directory to find additional header files. - `purelib` and `platlib`: Installed to the `site-packages` directory. It is not recommended - to uses these two options. + to use these two options. **Default value**: `{}` @@ -435,7 +435,7 @@ data files are included by placing them in the Python module instead of using da ```toml title="pyproject.toml" [tool.uv.build-backend] -data = { "headers": "include/headers", "scripts": "bin" } +data = { headers = "include/headers", scripts = "bin" } ``` --- diff --git a/uv.schema.json b/uv.schema.json index d8346aab1..7ca04d4f8 100644 --- a/uv.schema.json +++ b/uv.schema.json @@ -659,7 +659,7 @@ "type": "object", "properties": { "data": { - "description": "Data includes for wheels.\n\nEach entry is a directory, whose contents are copied to the matching directory in the wheel\nin `-.data/(purelib|platlib|headers|scripts|data)`. Upon installation, this\ndata is moved to its target location, as defined by\n. Usually, small\ndata files are included by placing them in the Python module instead of using data includes.\n\n- `scripts`: Installed to the directory for executables, `/bin` on Unix or\n `\\Scripts` on Windows. This directory is added to `PATH` when the virtual\n environment is activated or when using `uv run`, so this data type can be used to install\n additional binaries. Consider using `project.scripts` instead for Python entrypoints.\n- `data`: Installed over the virtualenv environment root.\n\n Warning: This may override existing files!\n\n- `headers`: Installed to the include directory. Compilers building Python packages\n with this package as build requirement use the include directory to find additional header\n files.\n- `purelib` and `platlib`: Installed to the `site-packages` directory. It is not recommended\n to uses these two options.", + "description": "Data includes for wheels.\n\nEach entry is a directory, whose contents are copied to the matching directory in the wheel\nin `-.data/(purelib|platlib|headers|scripts|data)`. Upon installation, this\ndata is moved to its target location, as defined by\n. Usually, small\ndata files are included by placing them in the Python module instead of using data includes.\n\n- `scripts`: Installed to the directory for executables, `/bin` on Unix or\n `\\Scripts` on Windows. This directory is added to `PATH` when the virtual\n environment is activated or when using `uv run`, so this data type can be used to install\n additional binaries. Consider using `project.scripts` instead for Python entrypoints.\n- `data`: Installed over the virtualenv environment root.\n\n Warning: This may override existing files!\n\n- `headers`: Installed to the include directory. Compilers building Python packages\n with this package as build requirement use the include directory to find additional header\n files.\n- `purelib` and `platlib`: Installed to the `site-packages` directory. It is not recommended\n to use these two options.", "allOf": [ { "$ref": "#/definitions/WheelDataIncludes"