Skip to content

Commit

Permalink
Fix invalid TOML syntax in examples of "config-settings" docs (astral…
Browse files Browse the repository at this point in the history
…-sh#5809)

## Summary

The snippet generated TOML errors when I copy/pasted it in my config
file, I believe there was a typo. 👍

## Test Plan

N/A
  • Loading branch information
Delgan authored Aug 6, 2024
1 parent 552c75c commit 3a24aec
Show file tree
Hide file tree
Showing 2 changed files with 6 additions and 6 deletions.
4 changes: 2 additions & 2 deletions crates/uv-settings/src/settings.rs
Original file line number Diff line number Diff line change
Expand Up @@ -312,7 +312,7 @@ pub struct ResolverInstallerOptions {
default = "{}",
value_type = "dict",
example = r#"
config-settings = { "editable_mode": "compat" }
config-settings = { editable_mode = "compat" }
"#
)]
pub config_settings: Option<ConfigSettings>,
Expand Down Expand Up @@ -843,7 +843,7 @@ pub struct PipOptions {
default = "{}",
value_type = "dict",
example = r#"
config-settings = { "editable_mode": "compat" }
config-settings = { editable_mode = "compat" }
"#
)]
pub config_settings: Option<ConfigSettings>,
Expand Down
8 changes: 4 additions & 4 deletions docs/reference/settings.md
Original file line number Diff line number Diff line change
Expand Up @@ -76,13 +76,13 @@ specified as `KEY=VALUE` pairs.

```toml
[tool.uv]
config-settings = { "editable_mode": "compat" }
config-settings = { editable_mode = "compat" }
```
=== "uv.toml"

```toml

config-settings = { "editable_mode": "compat" }
config-settings = { editable_mode = "compat" }
```

---
Expand Down Expand Up @@ -1063,13 +1063,13 @@ specified as `KEY=VALUE` pairs.

```toml
[tool.uv.pip]
config-settings = { "editable_mode": "compat" }
config-settings = { editable_mode = "compat" }
```
=== "uv.toml"

```toml
[pip]
config-settings = { "editable_mode": "compat" }
config-settings = { editable_mode = "compat" }
```

---
Expand Down

0 comments on commit 3a24aec

Please sign in to comment.