-
Notifications
You must be signed in to change notification settings - Fork 669
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Documentation feedback #5605
Comments
https://docs.astral.sh/uv/concepts/python-versions/#adjusting-python-version-preferences |
We don't have a commands to modify a persistent configuration file — you can put it in a
Thanks for the feedback though! Sounds like we should link to the persistent configuration documentation here. |
A little suggestion: add the use of I habitually use --help to see what commands I can use. PS: I don't understand why it should be hidden in --help. Except for this command, the outputs of |
I'm not sure why it's hidden — I copied this from Ruff. I think it might be because it shifts the indent for the rest of the commands way to the right and dramatically reduces the space we have for concise documentation. Thanks for the feedback! Tracked in #6153 |
Maybe we can improve the |
On
This sounded to me as if By the way, I added this to my 00 00 * * * uv self update |
Minor confusion for me in https://docs.astral.sh/uv/concepts/tools/, emphasis mine:
...
For Furthermore, what does it mean "disposable" in this context? In my first reading I understood If I do |
One suggestion would be to reiterate in the CLI reference docs for Another thing is that in the tool concepts page, it directly references
In both these cases, the implicit assumption is that the user knows that |
(Thanks for the feedback everyone, I'll attempt to address all that) We should talk about defining constraints in the |
@gusutabopb let me know if #6468 is sufficient! |
Hi! I hope this is the correct place, but I would request examples for:
I ask because this does not work from my existing pyproject.toml:
I add auth to the config by running:
Finding the equivalent of that last line for I'm similarly interested in jfrog examples, but this is the one I can provide the most specific details on. |
The FastAPI guide needs to be updated to reflect the changes introduced to the default behavior of |
|
I'm not sure why there's a python-version file if this information is also in the |
The documentation about running scripts using the inline metadata (link) doesn't mention support for specifying the dependency sources via the # /// script
# requires-python = ">=3.12"
# dependencies = [
# "requests",
# ]
# [tool.uv.sources]
# requests = { git = "https://github.com/psf/requests.git", tag = "v2.32.2" }
# ///
import requests
print(requests.__version__) # 2.32.2 (2.32.3 is the latest) I think the documentation can be explicit about officially supporting (or not supporting) it. |
@shunichironomura thanks! I think we need to create a separate "Scripts" concept page because that's way too advanced for the "guide" documentation. |
Would be nice to have information on whether virtual workspaces (no |
You might be looking for this: https://docs.astral.sh/uv/concepts/projects/#applications |
That is still an application that has its own python code from what I can tell. The Cargo virtual workspaces just combine related packages together, where there isn't necessarily one "main" binary. Taking from the workspace example in uv docs,
imagine And just to be clear, I'm not asking this feature to be implemented, only clarification on whether or not it is supported because the documentation page explicitly refers to Cargo. |
I have a couple questions about the lockfile after reading the docs on it. Is the The reason I'm looking for a schema / specification is that I would like to be able to parse My other question is whether you expect the |
@scimas Virtual projects were removed in #6720 (from the docs at least - cannot quickly find other pointers) |
@scimas -- Yeah that layout is fully supported. You can create a @astrojuanlu -- We removed most mentions of "virtual" since it wasn't a familiar concept, but the idea of a project that just lists members and dependencies is still supported. |
@willmurphyscode -- It's not documented anywhere, only implicitly in code. We don't have any planned changes but I'm sure it will change over time (it's also versioned). Separately, if PEP 751 is approved (which I've been very involved in), we'll likely migrate to whatever the approved format is, if it works for uv. |
The section Non-editable installs led me to a mistake. It mentions the following:
And then:
The problem is that, if I understand correctly, this is only true if the project was created as a library ( I suggest to make it more clear that only library projects are installed in the environment, regardless of the flag |
@zanieb I would also like to know this. |
@debnath-d The |
For me, if you use It's the same feeling I have when I use If BTW, |
It would be great if you:
|
I think it would be great if there a page about how to migrate from poetry. |
In the documentation about configuration, I find it confusing that many settings can be set in both What is the difference? Is there inheritance? Should I set them in both places? List of the 23 impacted settings at the time of writing
|
@mdegis you can track that at #5200 @Rogdham please see https://docs.astral.sh/uv/configuration/files/#configuring-the-pip-interface |
It'd be good to mention in the working on projects section of the guide, perhaps under the "running commands" part, that you need to include a build system or the library won't be available. This is a pretty confusing footgun that lost me most of a day while trying to work out why The only mention of this I can find is an easy-to-misread sentence under the build systems part of |
👍 sorry to hear that @yaleman — that change was made after we wrote most of the documentation and I've been meaning to rewrite the project documentation to account for that. |
Thank you for this, much helpful! Maybe just add a link to it in https://docs.astral.sh/uv/configuration/files/#configuring-the-pip-interface? A small note in each field of pip config saying that it inherits would be ideal, but I understand that this is quite some work for little benefit. |
Thanks for your work on the project. Here in the documentation it says to change the environment variable but nowhere on how to do that |
This is a tracking issue for feedback on the new documentation at https://docs.astral.sh/uv/
The text was updated successfully, but these errors were encountered: