Skip to content

Commit

Permalink
docs: fix a few typos (#10675)
Browse files Browse the repository at this point in the history
## Summary

Fixing a few typos found in the documentation and in comments.
  • Loading branch information
mkniewallner authored Jan 16, 2025
1 parent 73cade1 commit b46c6db
Show file tree
Hide file tree
Showing 9 changed files with 19 additions and 19 deletions.
4 changes: 2 additions & 2 deletions crates/uv-cli/src/lib.rs
Original file line number Diff line number Diff line change
Expand Up @@ -2395,8 +2395,8 @@ pub struct VenvArgs {
/// the directory name. If not provided (`uv venv`), the prompt is set to
/// the current directory's name.
///
/// If "." is provided, the the current directory name will be used
/// regardless of whether a path was provided to `uv venv`.
/// If "." is provided, the current directory name will be used regardless
/// of whether a path was provided to `uv venv`.
#[arg(long, verbatim_doc_comment)]
pub prompt: Option<String>,

Expand Down
2 changes: 1 addition & 1 deletion crates/uv-pep508/src/marker/algebra.rs
Original file line number Diff line number Diff line change
Expand Up @@ -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
// 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
// the the specifier into its `python_full_version` equivalent.
// the specifier into its `python_full_version` equivalent.
if let Some((major, minor)) = major_minor {
let version = Version::new([major, minor]);

Expand Down
2 changes: 1 addition & 1 deletion crates/uv-python/src/discovery.rs
Original file line number Diff line number Diff line change
Expand Up @@ -414,7 +414,7 @@ fn python_executables<'a>(
})
.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(|| {
conda_environment_from_env(CondaEnvironmentKind::Base)
.into_iter()
Expand Down
2 changes: 1 addition & 1 deletion crates/uv-resolver/src/pubgrub/report.rs
Original file line number Diff line number Diff line change
Expand Up @@ -1847,7 +1847,7 @@ fn update_availability_range(
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
// `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) {
continue;
}
Expand Down
10 changes: 5 additions & 5 deletions crates/uv-workspace/src/pyproject.rs
Original file line number Diff line number Diff line change
Expand Up @@ -316,7 +316,7 @@ pub struct ToolUv {
/// [`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.
///
/// 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:
///
/// ```toml
Expand Down Expand Up @@ -394,8 +394,8 @@ pub struct ToolUv {
///
/// 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
/// `tool.uv.dev-dependencies` and `dependency-groups.dev` are combined to determine the the
/// final requirements of the `dev` dependency group.
/// `tool.uv.dev-dependencies` and `dependency-groups.dev` are combined to determine the final
/// requirements of the `dev` dependency group.
#[cfg_attr(
feature = "schemars",
schemars(
Expand Down Expand Up @@ -473,7 +473,7 @@ pub struct ToolUv {
value_type = "list[str]",
example = r#"
# 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"]
"#
)]
Expand All @@ -485,7 +485,7 @@ pub struct ToolUv {
/// However, you can restrict the set of supported environments to improve performance and avoid
/// 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.
#[cfg_attr(
feature = "schemars",
Expand Down
4 changes: 2 additions & 2 deletions crates/uv/src/commands/python/pin.rs
Original file line number Diff line number Diff line change
Expand Up @@ -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
// to check for compatibility on the current system.
// If there is not a version in the pinned request, attempt to resolve the pin into an
// interpreter to check for compatibility on the current system.
match PythonInstallation::find(
pin,
EnvironmentPreference::OnlySystem,
Expand Down
2 changes: 1 addition & 1 deletion docs/reference/cli.md
Original file line number Diff line number Diff line change
Expand Up @@ -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&#8217;s name.</p>

<p>If &quot;.&quot; 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 &quot;.&quot; 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>

Expand Down
10 changes: 5 additions & 5 deletions docs/reference/settings.md
Original file line number Diff line number Diff line change
Expand Up @@ -75,7 +75,7 @@ transitive dependencies.
```toml title="pyproject.toml"
[tool.uv]
# 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"]
```

Expand Down Expand Up @@ -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
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
final requirements of the `dev` dependency group.
`tool.uv.dev-dependencies` and `dependency-groups.dev` are combined to determine the final
requirements of the `dev` dependency group.

**Default value**: `[]`

Expand All @@ -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
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.

**Default value**: `[]`
Expand Down Expand Up @@ -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
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:

```toml
Expand Down
2 changes: 1 addition & 1 deletion uv.schema.json

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

0 comments on commit b46c6db

Please sign in to comment.