uv icon indicating copy to clipboard operation
uv copied to clipboard

Documentation for the behavior of `source-exclude`

Open himkt opened this issue 1 week ago • 1 comments

Question

Hello uv developers, thank you so much for your all efforts to develop uv! I want to suggest one small suggestion for the documentation.

At first, I didn't understand the behaviors of source-exclude and wheel-exclude of uv build backend; specifying wheel-exclude only affects the contents of .whl but source-exclude affects both .tar.gz and .whl.

There are two options both for sdist and wheel (https://docs.astral.sh/uv/reference/settings/#build-backend_source-exclude and https://docs.astral.sh/uv/reference/settings/#build-backend_wheel-exclude), made me think that each option would work for sdist and wheel, respectively. But when I create a wheel, the setting in source-exclude also applied to .whl (which surprised me a bit).

After reading the documentation of uv build, I noticed that the wheel was made from the source distribution when I ran uv build (not uv build --sdist --wheel) and I understand the reason of this behavior (so, I had to read the docs more carefully). But I also think it would take time to understand this behavior for users directly landing the settings documentation.

Given the journey, I have one suggestion; how about adding some explanation about uv build (=wheel will be created from sdist) in the documentation for source-exclude? (I think it would be sufficient to add a link to uv-build from https://docs.astral.sh/uv/reference/settings/#build-backend_source-exclude). Of course, I'd be happy to make a pull request if it would help.

Platform

No response

Version

No response

himkt avatar Nov 23 '25 09:11 himkt