Clarify exclude-newer only allows full timestamps in settings docs (#9135)

<!--
Thank you for contributing to uv! To help us out with reviewing, please
consider the following:

- Does this pull request include a summary of the change? (See below.)
- Does this pull request include a descriptive title?
- Does this pull request include references to any relevant issues?
-->

## Summary

Follow up to #8553

Clarifies that the `exclude-newer` setting must be a full timestamp and
not a date.

<!-- What's the purpose of the change? What does it do, and why? -->

## Test Plan

N/A

<!-- How was it tested? -->
This commit is contained in:
Trevor Manz 2025-01-06 10:03:21 -05:00 committed by GitHub
parent 523b88edf0
commit 54b9e8ff82
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
3 changed files with 12 additions and 12 deletions

View file

@ -1276,16 +1276,16 @@ pub struct PipOptions {
"#
)]
pub universal: Option<bool>,
/// Limit candidate packages to those that were uploaded prior to the given date.
/// Limit candidate packages to those that were uploaded prior to a given point in time.
///
/// Accepts both [RFC 3339](https://www.rfc-editor.org/rfc/rfc3339.html) timestamps (e.g.,
/// `2006-12-02T02:07:43Z`) and local dates in the same format (e.g., `2006-12-02`) in your
/// system's configured time zone.
/// Accepts a superset of [RFC 3339](https://www.rfc-editor.org/rfc/rfc3339.html) (e.g.,
/// `2006-12-02T02:07:43Z`). A full timestamp is required to ensure that the resolver will
/// behave consistently across timezones.
#[option(
default = "None",
value_type = "str",
example = r#"
exclude-newer = "2006-12-02"
exclude-newer = "2006-12-02T02:07:43Z"
"#
)]
pub exclude_newer: Option<ExcludeNewer>,

View file

@ -2055,11 +2055,11 @@ be correct.
#### [`exclude-newer`](#pip_exclude-newer) {: #pip_exclude-newer }
<span id="exclude-newer"></span>
Limit candidate packages to those that were uploaded prior to the given date.
Limit candidate packages to those that were uploaded prior to a given point in time.
Accepts both [RFC 3339](https://www.rfc-editor.org/rfc/rfc3339.html) timestamps (e.g.,
`2006-12-02T02:07:43Z`) and local dates in the same format (e.g., `2006-12-02`) in your
system's configured time zone.
Accepts a superset of [RFC 3339](https://www.rfc-editor.org/rfc/rfc3339.html) (e.g.,
`2006-12-02T02:07:43Z`). A full timestamp is required to ensure that the resolver will
behave consistently across timezones.
**Default value**: `None`
@ -2071,13 +2071,13 @@ system's configured time zone.
```toml
[tool.uv.pip]
exclude-newer = "2006-12-02"
exclude-newer = "2006-12-02T02:07:43Z"
```
=== "uv.toml"
```toml
[pip]
exclude-newer = "2006-12-02"
exclude-newer = "2006-12-02T02:07:43Z"
```
---

2
uv.schema.json generated
View file

@ -960,7 +960,7 @@
]
},
"exclude-newer": {
"description": "Limit candidate packages to those that were uploaded prior to the given date.\n\nAccepts both [RFC 3339](https://www.rfc-editor.org/rfc/rfc3339.html) timestamps (e.g., `2006-12-02T02:07:43Z`) and local dates in the same format (e.g., `2006-12-02`) in your system's configured time zone.",
"description": "Limit candidate packages to those that were uploaded prior to a given point in time.\n\nAccepts a superset of [RFC 3339](https://www.rfc-editor.org/rfc/rfc3339.html) (e.g., `2006-12-02T02:07:43Z`). A full timestamp is required to ensure that the resolver will behave consistently across timezones.",
"anyOf": [
{
"$ref": "#/definitions/ExcludeNewer"