Python
/
uv
mirror of https://github.com/astral-sh/uv
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

docs: fix invalid syntax in some sources examples (#10127) 

## Summary

TOML 1.0 doesn't support multi-line for inline tables, so those examples
are invalid.
This commit is contained in:
Mathieu Kniewallner 2024-12-23 22:12:45 +01:00 committed by GitHub
parent 755ca8efb5
commit b24fb774b1
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
3 changed files with 8 additions and 29 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
crates/uv-workspace/src/pyproject.rs
View File

@ -292,7 +292,7 @@ pub struct ToolUv {
example = r#"
[tool.uv.sources]
httpx = { git = "https://github.com/encode/httpx", tag = "0.27.0" }
pytest = { url = "https://files.pythonhosted.org/packages/6b/77/7440a06a8ead44c7757a64362dd22df5760f9b12dc5f11b6188cd2fc27a0/pytest-8.3.3-py3-none-any.whl" }
pytest = { url = "https://files.pythonhosted.org/packages/6b/77/7440a06a8ead44c7757a64362dd22df5760f9b12dc5f11b6188cd2fc27a0/pytest-8.3.3-py3-none-any.whl" }
pydantic = { path = "/path/to/pydantic", editable = true }
"#
)]

33
docs/concepts/projects/dependencies.md
View File

@ -290,10 +290,7 @@ $ uv add git+https://github.com/encode/httpx --tag 0.27.0
dependencies = ["httpx"]
[tool.uv.sources]
httpx = {
git = "https://github.com/encode/httpx",
tag = "0.27.0"
}
httpx = { git = "https://github.com/encode/httpx", tag = "0.27.0" }
```
Or, a branch:
@ -307,10 +304,7 @@ $ uv add git+https://github.com/encode/httpx --branch main
dependencies = ["httpx"]
[tool.uv.sources]
httpx = {
git = "https://github.com/encode/httpx",
branch = "main"
}
httpx = { git = "https://github.com/encode/httpx", branch = "main" }
```
Or, a revision (commit):
@ -324,10 +318,7 @@ $ uv add git+https://github.com/encode/httpx --rev 326b9431c761e1ef1e00b9f760d1f
dependencies = ["httpx"]
[tool.uv.sources]
httpx = {
git = "https://github.com/encode/httpx",
rev = "326b9431c761e1ef1e00b9f760d1f654c8db48c6"
}
httpx = { git = "https://github.com/encode/httpx", rev = "326b9431c761e1ef1e00b9f760d1f654c8db48c6" }
```
A `subdirectory` may be specified if the package isn't in the repository root.
@ -438,11 +429,7 @@ For example, to pull `httpx` from GitHub, but only on macOS, use the following:
dependencies = ["httpx"]
[tool.uv.sources]
httpx = {
git = "https://github.com/encode/httpx",
tag = "0.27.2",
marker = "sys_platform == 'darwin'"
}
httpx = { git = "https://github.com/encode/httpx", tag = "0.27.2", marker = "sys_platform == 'darwin'" }
```
By specifying the marker on the source, uv will still include `httpx` on all platforms, but will
@ -462,16 +449,8 @@ dependencies = ["httpx"]
[tool.uv.sources]
httpx = [
{
git = "https://github.com/encode/httpx",
tag = "0.27.2",
marker = "sys_platform == 'darwin'"
},
{
git = "https://github.com/encode/httpx",
tag = "0.24.1",
marker = "sys_platform == 'linux'"
},
{ git = "https://github.com/encode/httpx", tag = "0.27.2", marker = "sys_platform == 'darwin'" },
{ git = "https://github.com/encode/httpx", tag = "0.24.1", marker = "sys_platform == 'linux'" },
]
```

2
docs/reference/settings.md
View File

@ -293,7 +293,7 @@ See [Dependencies](../concepts/projects/dependencies.md) for more.
[tool.uv.sources]
httpx = { git = "https://github.com/encode/httpx", tag = "0.27.0" }
pytest = { url = "https://files.pythonhosted.org/packages/6b/77/7440a06a8ead44c7757a64362dd22df5760f9b12dc5f11b6188cd2fc27a0/pytest-8.3.3-py3-none-any.whl" }
pytest = { url = "https://files.pythonhosted.org/packages/6b/77/7440a06a8ead44c7757a64362dd22df5760f9b12dc5f11b6188cd2fc27a0/pytest-8.3.3-py3-none-any.whl" }
pydantic = { path = "/path/to/pydantic", editable = true }
```