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 <konstin@mailbox.org>
This commit is contained in:
Elijah Hartvigsen 2025-07-24 11:55:14 +02:00 committed by GitHub
parent 02e103f867
commit 3b59515614
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
3 changed files with 5 additions and 5 deletions

View File

@ -155,7 +155,7 @@ pub struct BuildBackendSettings {
/// with this package as build requirement use the include directory to find additional header /// with this package as build requirement use the include directory to find additional header
/// files. /// files.
/// - `purelib` and `platlib`: Installed to the `site-packages` directory. It is not recommended /// - `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. // TODO(konsti): We should show a flat example instead.
// ```toml // ```toml
// [tool.uv.build-backend.data] // [tool.uv.build-backend.data]
@ -165,7 +165,7 @@ pub struct BuildBackendSettings {
#[option( #[option(
default = r#"{}"#, default = r#"{}"#,
value_type = "dict[str, str]", value_type = "dict[str, str]",
example = r#"data = { "headers": "include/headers", "scripts": "bin" }"# example = r#"data = { headers = "include/headers", scripts = "bin" }"#
)] )]
pub data: WheelDataIncludes, pub data: WheelDataIncludes,
} }

View File

@ -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 with this package as build requirement use the include directory to find additional header
files. files.
- `purelib` and `platlib`: Installed to the `site-packages` directory. It is not recommended - `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**: `{}` **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" ```toml title="pyproject.toml"
[tool.uv.build-backend] [tool.uv.build-backend]
data = { "headers": "include/headers", "scripts": "bin" } data = { headers = "include/headers", scripts = "bin" }
``` ```
--- ---

2
uv.schema.json generated
View File

@ -659,7 +659,7 @@
"type": "object", "type": "object",
"properties": { "properties": {
"data": { "data": {
"description": "Data includes for wheels.\n\nEach entry is a directory, whose contents are copied to the matching directory in the wheel\nin `<name>-<version>.data/(purelib|platlib|headers|scripts|data)`. Upon installation, this\ndata is moved to its target location, as defined by\n<https://docs.python.org/3.12/library/sysconfig.html#installation-paths>. 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, `<venv>/bin` on Unix or\n `<venv>\\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 `<name>-<version>.data/(purelib|platlib|headers|scripts|data)`. Upon installation, this\ndata is moved to its target location, as defined by\n<https://docs.python.org/3.12/library/sysconfig.html#installation-paths>. 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, `<venv>/bin` on Unix or\n `<venv>\\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": [ "allOf": [
{ {
"$ref": "#/definitions/WheelDataIncludes" "$ref": "#/definitions/WheelDataIncludes"