Add reference documentation for resolver settings (#5122)

## Summary

First part of https://github.com/astral-sh/uv/issues/5093.

Remaining:

- Global settings
- `pip`-specific settings (some will be copied-over from here)
- Auto-generating the "Possible values" for enums
This commit is contained in:
Charlie Marsh 2024-07-16 16:39:22 -04:00 committed by GitHub
parent abb6ac5127
commit 616a61a244
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
5 changed files with 808 additions and 36 deletions

View file

@ -92,7 +92,7 @@ pub struct ToolUv {
feature = "schemars",
schemars(
with = "Option<Vec<String>>",
description = "PEP 508-style requirements, e.g., `flask==3.0.0`, or `black @ https://...`."
description = "PEP 508-style requirements, e.g., `ruff==0.5.0`, or `ruff @ https://...`."
)
)]
pub dev_dependencies: Option<Vec<pep508_rs::Requirement<VerbatimParsedUrl>>>,
@ -100,7 +100,7 @@ pub struct ToolUv {
feature = "schemars",
schemars(
with = "Option<Vec<String>>",
description = "PEP 508 style requirements, e.g. `flask==3.0.0`, or `black @ https://...`."
description = "PEP 508 style requirements, e.g. `ruff==0.5.0`, or `ruff @ https://...`."
)
)]
pub override_dependencies: Option<Vec<pep508_rs::Requirement<VerbatimParsedUrl>>>,