-
Notifications
You must be signed in to change notification settings - Fork 615
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
Improve CLI documentation for uv run
#5841
Conversation
crates/uv-cli/src/lib.rs
Outdated
/// `pyproject.toml`. | ||
/// | ||
/// This option is only available when running in a project or invoking a | ||
/// script with inline metadata. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I don't think this applies to inline metadata, does it?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I'm not sure. You can have a tool.uv
section? I guess I'll check
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I don't think we would respect that, because we return:
/// PEP 723 metadata as parsed from a `script` comment block.
///
/// See: <https://peps.python.org/pep-0723/>
#[derive(Debug, Serialize, Deserialize)]
#[serde(rename_all = "kebab-case")]
pub struct Pep723Metadata {
pub dependencies: Vec<pep508_rs::Requirement<VerbatimParsedUrl>>,
pub requires_python: Option<pep440_rs::VersionSpecifiers>,
}
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Yeah I confirmed we do not, which is debatably wrong. I'm fine with not reading [tool.uv.dev-dependencies]
but we do need to respect [tool.uv]
settings: #5855
e9286a2
to
814b79a
Compare
Adds more long-form help to
uv run
, which renders inuv help run
and the CLI reference on the website.