mirror of https://github.com/astral-sh/uv
Follow the style guide in the style guide (#16466)
<!-- 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 <!-- What's the purpose of the change? What does it do, and why? --> > 4. Hyphenate compound words, e.g., use "platform-specific" not "platform specific". Applies to "command line arguments" -> "command-line arguments".
This commit is contained in:
parent
804f1ff808
commit
399094aedc
2
STYLE.md
2
STYLE.md
|
|
@ -16,7 +16,7 @@ documentation_.
|
||||||
1. If a message ends with a single relevant value, precede it with a colon, e.g.,
|
1. If a message ends with a single relevant value, precede it with a colon, e.g.,
|
||||||
`This is the value: value`. If the value is a literal, wrap it in backticks.
|
`This is the value: value`. If the value is a literal, wrap it in backticks.
|
||||||
1. Markdown files should be wrapped at 100 characters.
|
1. Markdown files should be wrapped at 100 characters.
|
||||||
1. Use a space, not an equals sign, for command line arguments with a value, e.g.
|
1. Use a space, not an equals sign, for command-line arguments with a value, e.g.
|
||||||
`--resolution lowest`, not `--resolution=lowest`.
|
`--resolution lowest`, not `--resolution=lowest`.
|
||||||
|
|
||||||
## Styling uv
|
## Styling uv
|
||||||
|
|
|
||||||
Loading…
Reference in New Issue