mirror of
https://github.com/astral-sh/uv.git
synced 2025-10-17 22:07:47 +00:00
docs: fix a few typos (#10675)
## Summary Fixing a few typos found in the documentation and in comments.
This commit is contained in:
parent
73cade1386
commit
b46c6db317
9 changed files with 19 additions and 19 deletions
|
@ -2395,8 +2395,8 @@ pub struct VenvArgs {
|
||||||
/// the directory name. If not provided (`uv venv`), the prompt is set to
|
/// the directory name. If not provided (`uv venv`), the prompt is set to
|
||||||
/// the current directory's name.
|
/// the current directory's name.
|
||||||
///
|
///
|
||||||
/// If "." is provided, the the current directory name will be used
|
/// If "." is provided, the current directory name will be used regardless
|
||||||
/// regardless of whether a path was provided to `uv venv`.
|
/// of whether a path was provided to `uv venv`.
|
||||||
#[arg(long, verbatim_doc_comment)]
|
#[arg(long, verbatim_doc_comment)]
|
||||||
pub prompt: Option<String>,
|
pub prompt: Option<String>,
|
||||||
|
|
||||||
|
|
|
@ -1556,7 +1556,7 @@ fn python_version_to_full_version(specifier: VersionSpecifier) -> Result<Version
|
||||||
// version segments. For example, a python version of `3.7.0`, `3.7.1`, and so on, would all
|
// version segments. For example, a python version of `3.7.0`, `3.7.1`, and so on, would all
|
||||||
// result in a `python_version` marker of `3.7`. For this reason, we must consider the range
|
// result in a `python_version` marker of `3.7`. For this reason, we must consider the range
|
||||||
// of values that would satisfy a `python_version` specifier when truncated in order to transform
|
// of values that would satisfy a `python_version` specifier when truncated in order to transform
|
||||||
// the the specifier into its `python_full_version` equivalent.
|
// the specifier into its `python_full_version` equivalent.
|
||||||
if let Some((major, minor)) = major_minor {
|
if let Some((major, minor)) = major_minor {
|
||||||
let version = Version::new([major, minor]);
|
let version = Version::new([major, minor]);
|
||||||
|
|
||||||
|
|
|
@ -414,7 +414,7 @@ fn python_executables<'a>(
|
||||||
})
|
})
|
||||||
.flatten();
|
.flatten();
|
||||||
|
|
||||||
// Check if the the base conda environment is active
|
// Check if the base conda environment is active
|
||||||
let from_base_conda_environment = iter::once_with(|| {
|
let from_base_conda_environment = iter::once_with(|| {
|
||||||
conda_environment_from_env(CondaEnvironmentKind::Base)
|
conda_environment_from_env(CondaEnvironmentKind::Base)
|
||||||
.into_iter()
|
.into_iter()
|
||||||
|
|
|
@ -1847,7 +1847,7 @@ fn update_availability_range(
|
||||||
let segment_range = Range::from_range_bounds((lower.clone(), upper.clone()));
|
let segment_range = Range::from_range_bounds((lower.clone(), upper.clone()));
|
||||||
|
|
||||||
// Drop the segment if it's disjoint with the available range, e.g., if the segment is
|
// Drop the segment if it's disjoint with the available range, e.g., if the segment is
|
||||||
// `foo>999`, and the the available versions are all `<10` it's useless to show.
|
// `foo>999`, and the available versions are all `<10` it's useless to show.
|
||||||
if segment_range.is_disjoint(&available_range) {
|
if segment_range.is_disjoint(&available_range) {
|
||||||
continue;
|
continue;
|
||||||
}
|
}
|
||||||
|
|
|
@ -316,7 +316,7 @@ pub struct ToolUv {
|
||||||
/// [`extra_index_url`](#extra-index-url). uv will only consider the first index that contains
|
/// [`extra_index_url`](#extra-index-url). uv will only consider the first index that contains
|
||||||
/// a given package, unless an alternative [index strategy](#index-strategy) is specified.
|
/// a given package, unless an alternative [index strategy](#index-strategy) is specified.
|
||||||
///
|
///
|
||||||
/// If an index is marked as `explicit = true`, it will be used exclusively for those
|
/// If an index is marked as `explicit = true`, it will be used exclusively for the
|
||||||
/// dependencies that select it explicitly via `[tool.uv.sources]`, as in:
|
/// dependencies that select it explicitly via `[tool.uv.sources]`, as in:
|
||||||
///
|
///
|
||||||
/// ```toml
|
/// ```toml
|
||||||
|
@ -394,8 +394,8 @@ pub struct ToolUv {
|
||||||
///
|
///
|
||||||
/// Use of this field is not recommend anymore. Instead, use the `dependency-groups.dev` field
|
/// Use of this field is not recommend anymore. Instead, use the `dependency-groups.dev` field
|
||||||
/// which is a standardized way to declare development dependencies. The contents of
|
/// which is a standardized way to declare development dependencies. The contents of
|
||||||
/// `tool.uv.dev-dependencies` and `dependency-groups.dev` are combined to determine the the
|
/// `tool.uv.dev-dependencies` and `dependency-groups.dev` are combined to determine the final
|
||||||
/// final requirements of the `dev` dependency group.
|
/// requirements of the `dev` dependency group.
|
||||||
#[cfg_attr(
|
#[cfg_attr(
|
||||||
feature = "schemars",
|
feature = "schemars",
|
||||||
schemars(
|
schemars(
|
||||||
|
@ -473,7 +473,7 @@ pub struct ToolUv {
|
||||||
value_type = "list[str]",
|
value_type = "list[str]",
|
||||||
example = r#"
|
example = r#"
|
||||||
# Ensure that the grpcio version is always less than 1.65, if it's requested by a
|
# Ensure that the grpcio version is always less than 1.65, if it's requested by a
|
||||||
# transitive dependency.
|
# direct or transitive dependency.
|
||||||
constraint-dependencies = ["grpcio<1.65"]
|
constraint-dependencies = ["grpcio<1.65"]
|
||||||
"#
|
"#
|
||||||
)]
|
)]
|
||||||
|
@ -485,7 +485,7 @@ pub struct ToolUv {
|
||||||
/// However, you can restrict the set of supported environments to improve performance and avoid
|
/// However, you can restrict the set of supported environments to improve performance and avoid
|
||||||
/// unsatisfiable branches in the solution space.
|
/// unsatisfiable branches in the solution space.
|
||||||
///
|
///
|
||||||
/// These environments will also respected when `uv pip compile` is invoked with the
|
/// These environments will also be respected when `uv pip compile` is invoked with the
|
||||||
/// `--universal` flag.
|
/// `--universal` flag.
|
||||||
#[cfg_attr(
|
#[cfg_attr(
|
||||||
feature = "schemars",
|
feature = "schemars",
|
||||||
|
|
|
@ -203,8 +203,8 @@ fn warn_if_existing_pin_incompatible_with_project(
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
// If the there is not a version in the pinned request, attempt to resolve the pin into an interpreter
|
// If there is not a version in the pinned request, attempt to resolve the pin into an
|
||||||
// to check for compatibility on the current system.
|
// interpreter to check for compatibility on the current system.
|
||||||
match PythonInstallation::find(
|
match PythonInstallation::find(
|
||||||
pin,
|
pin,
|
||||||
EnvironmentPreference::OnlySystem,
|
EnvironmentPreference::OnlySystem,
|
||||||
|
|
|
@ -8035,7 +8035,7 @@ uv venv [OPTIONS] [PATH]
|
||||||
|
|
||||||
<p>By default, the prompt is dependent on whether a path was provided to <code>uv venv</code>. If provided (e.g, <code>uv venv project</code>), the prompt is set to the directory name. If not provided (<code>uv venv</code>), the prompt is set to the current directory’s name.</p>
|
<p>By default, the prompt is dependent on whether a path was provided to <code>uv venv</code>. If provided (e.g, <code>uv venv project</code>), the prompt is set to the directory name. If not provided (<code>uv venv</code>), the prompt is set to the current directory’s name.</p>
|
||||||
|
|
||||||
<p>If "." is provided, the the current directory name will be used regardless of whether a path was provided to <code>uv venv</code>.</p>
|
<p>If "." is provided, the current directory name will be used regardless of whether a path was provided to <code>uv venv</code>.</p>
|
||||||
|
|
||||||
</dd><dt><code>--python</code>, <code>-p</code> <i>python</i></dt><dd><p>The Python interpreter to use for the virtual environment.</p>
|
</dd><dt><code>--python</code>, <code>-p</code> <i>python</i></dt><dd><p>The Python interpreter to use for the virtual environment.</p>
|
||||||
|
|
||||||
|
|
|
@ -75,7 +75,7 @@ transitive dependencies.
|
||||||
```toml title="pyproject.toml"
|
```toml title="pyproject.toml"
|
||||||
[tool.uv]
|
[tool.uv]
|
||||||
# Ensure that the grpcio version is always less than 1.65, if it's requested by a
|
# Ensure that the grpcio version is always less than 1.65, if it's requested by a
|
||||||
# transitive dependency.
|
# direct or transitive dependency.
|
||||||
constraint-dependencies = ["grpcio<1.65"]
|
constraint-dependencies = ["grpcio<1.65"]
|
||||||
```
|
```
|
||||||
|
|
||||||
|
@ -107,8 +107,8 @@ not appear in the project's published metadata.
|
||||||
|
|
||||||
Use of this field is not recommend anymore. Instead, use the `dependency-groups.dev` field
|
Use of this field is not recommend anymore. Instead, use the `dependency-groups.dev` field
|
||||||
which is a standardized way to declare development dependencies. The contents of
|
which is a standardized way to declare development dependencies. The contents of
|
||||||
`tool.uv.dev-dependencies` and `dependency-groups.dev` are combined to determine the the
|
`tool.uv.dev-dependencies` and `dependency-groups.dev` are combined to determine the final
|
||||||
final requirements of the `dev` dependency group.
|
requirements of the `dev` dependency group.
|
||||||
|
|
||||||
**Default value**: `[]`
|
**Default value**: `[]`
|
||||||
|
|
||||||
|
@ -131,7 +131,7 @@ By default, uv will resolve for all possible environments during a `uv lock` ope
|
||||||
However, you can restrict the set of supported environments to improve performance and avoid
|
However, you can restrict the set of supported environments to improve performance and avoid
|
||||||
unsatisfiable branches in the solution space.
|
unsatisfiable branches in the solution space.
|
||||||
|
|
||||||
These environments will also respected when `uv pip compile` is invoked with the
|
These environments will also be respected when `uv pip compile` is invoked with the
|
||||||
`--universal` flag.
|
`--universal` flag.
|
||||||
|
|
||||||
**Default value**: `[]`
|
**Default value**: `[]`
|
||||||
|
@ -161,7 +161,7 @@ higher priority than any indexes specified via [`index_url`](#index-url) or
|
||||||
[`extra_index_url`](#extra-index-url). uv will only consider the first index that contains
|
[`extra_index_url`](#extra-index-url). uv will only consider the first index that contains
|
||||||
a given package, unless an alternative [index strategy](#index-strategy) is specified.
|
a given package, unless an alternative [index strategy](#index-strategy) is specified.
|
||||||
|
|
||||||
If an index is marked as `explicit = true`, it will be used exclusively for those
|
If an index is marked as `explicit = true`, it will be used exclusively for the
|
||||||
dependencies that select it explicitly via `[tool.uv.sources]`, as in:
|
dependencies that select it explicitly via `[tool.uv.sources]`, as in:
|
||||||
|
|
||||||
```toml
|
```toml
|
||||||
|
|
2
uv.schema.json
generated
2
uv.schema.json
generated
|
@ -191,7 +191,7 @@
|
||||||
]
|
]
|
||||||
},
|
},
|
||||||
"index": {
|
"index": {
|
||||||
"description": "The indexes to use when resolving dependencies.\n\nAccepts either a repository compliant with [PEP 503](https://peps.python.org/pep-0503/) (the simple repository API), or a local directory laid out in the same format.\n\nIndexes are considered in the order in which they're defined, such that the first-defined index has the highest priority. Further, the indexes provided by this setting are given higher priority than any indexes specified via [`index_url`](#index-url) or [`extra_index_url`](#extra-index-url). uv will only consider the first index that contains a given package, unless an alternative [index strategy](#index-strategy) is specified.\n\nIf an index is marked as `explicit = true`, it will be used exclusively for those dependencies that select it explicitly via `[tool.uv.sources]`, as in:\n\n```toml [[tool.uv.index]] name = \"pytorch\" url = \"https://download.pytorch.org/whl/cu121\" explicit = true\n\n[tool.uv.sources] torch = { index = \"pytorch\" } ```\n\nIf an index is marked as `default = true`, it will be moved to the end of the prioritized list, such that it is given the lowest priority when resolving packages. Additionally, marking an index as default will disable the PyPI default index.",
|
"description": "The indexes to use when resolving dependencies.\n\nAccepts either a repository compliant with [PEP 503](https://peps.python.org/pep-0503/) (the simple repository API), or a local directory laid out in the same format.\n\nIndexes are considered in the order in which they're defined, such that the first-defined index has the highest priority. Further, the indexes provided by this setting are given higher priority than any indexes specified via [`index_url`](#index-url) or [`extra_index_url`](#extra-index-url). uv will only consider the first index that contains a given package, unless an alternative [index strategy](#index-strategy) is specified.\n\nIf an index is marked as `explicit = true`, it will be used exclusively for the dependencies that select it explicitly via `[tool.uv.sources]`, as in:\n\n```toml [[tool.uv.index]] name = \"pytorch\" url = \"https://download.pytorch.org/whl/cu121\" explicit = true\n\n[tool.uv.sources] torch = { index = \"pytorch\" } ```\n\nIf an index is marked as `default = true`, it will be moved to the end of the prioritized list, such that it is given the lowest priority when resolving packages. Additionally, marking an index as default will disable the PyPI default index.",
|
||||||
"type": [
|
"type": [
|
||||||
"array",
|
"array",
|
||||||
"null"
|
"null"
|
||||||
|
|
Loading…
Add table
Add a link
Reference in a new issue