Skip to content

Commit

Permalink
Improve and fix some documents (#8749)
Browse files Browse the repository at this point in the history
<!--
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? -->

## Test Plan

<!-- How was it tested? -->
  • Loading branch information
ShapelessCat authored Nov 1, 2024
1 parent bf8436c commit f829114
Show file tree
Hide file tree
Showing 3 changed files with 4 additions and 4 deletions.
2 changes: 1 addition & 1 deletion CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -200,7 +200,7 @@ Releases can only be performed by Astral team members.

Changelog entries and version bumps are automated. First, run:

```
```shell
./scripts/release.sh
```

Expand Down
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -285,8 +285,8 @@ for Windows support.
uv is licensed under either of

- Apache License, Version 2.0, ([LICENSE-APACHE](LICENSE-APACHE) or
https://www.apache.org/licenses/LICENSE-2.0)
- MIT license ([LICENSE-MIT](LICENSE-MIT) or https://opensource.org/licenses/MIT)
<https://www.apache.org/licenses/LICENSE-2.0>)
- MIT license ([LICENSE-MIT](LICENSE-MIT) or <https://opensource.org/licenses/MIT>)

at your option.

Expand Down
2 changes: 1 addition & 1 deletion STYLE.md
Original file line number Diff line number Diff line change
Expand Up @@ -122,7 +122,7 @@ The documentation is divided into:

### Warnings

1. `warn_user` and `warn_user_once` are shown without the `--verbose `flag.
1. `warn_user` and `warn_user_once` are shown without the `--verbose` flag.
- These methods should be preferred over tracing warnings when the warning is actionable.
- Deprecation warnings should use these methods.
1. Deprecation warnings must be actionable.
Expand Down

0 comments on commit f829114

Please sign in to comment.