mirrors/uv
1
0
Fork 0
mirror of https://github.com/astral-sh/uv.git synced 2025-07-07 13:25:00 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 2

Minimal markdown nits (#1664)

Browse source 
VSCode complained about these when I was starting on #1662
This commit is contained in:
Simon Brugman 2024-02-18 19:32:37 +01:00 • committed by GitHub
parent 5cdc6de4a9
commit ceb953be0f
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
2 changed files with 7 additions and 8 deletions
Download patch file Download diff file Expand all files Collapse all files

1
BENCHMARKS.md
View file

@ -105,7 +105,6 @@ You need to install the [Roboto Font](https://fonts.google.com/specimen/Roboto)
The inclusion of this `BENCHMARKS.md` file was inspired by the excellent benchmarking documentation
in [Orogene](https://github.com/orogene/orogene/blob/472e481b4fc6e97c2b57e69240bf8fe995dfab83/BENCHMARKS.md).
## Troubleshooting
### Flaky benchmarks

14
CONTRIBUTING.md
View file

@ -6,7 +6,6 @@
### Linux
On Ubuntu and other Debian-based distributions, you can install the C compiler and CMake with
```shell
@ -17,13 +16,13 @@ sudo apt install build-essential cmake
CMake may be installed with Homebrew:
```
```shell
brew install cmake
```
The Python bootstrapping script requires `coreutils` and `zstd`; we recommend installing them with Homebrew:
```
```shell
brew install coreutils zstd
```
@ -39,6 +38,7 @@ You can install CMake from the [installers](https://cmake.org/download/) or with
For running tests, we recommend [nextest](https://nexte.st/).
### Python
Testing uv requires multiple specific Python versions. You can install them into
`<project root>/bin` via our bootstrapping script:
@ -48,13 +48,13 @@ pipx run scripts/bootstrap/install.py
Alternatively, you can install `zstandard` from PyPI, then run:
```
```shell
python3.12 scripts/bootstrap/install.py
```
## Running inside a docker container
Source distributions can run arbitrary code on build and can make unwanted modifications to your system (https://moyix.blogspot.com/2022/09/someones-been-messing-with-my-subnormals.html, https://pypi.org/project/nvidia-pyindex/), which can even occur when just resolving requirements. To prevent this, there's a Docker container you can run commands in:
Source distributions can run arbitrary code on build and can make unwanted modifications to your system (["Someone's Been Messing With My Subnormals!" on Blogspot](https://moyix.blogspot.com/2022/09/someones-been-messing-with-my-subnormals.html), ["nvidia-pyindex" on PyPI](https://pypi.org/project/nvidia-pyindex/)), which can even occur when just resolving requirements. To prevent this, there's a Docker container you can run commands in:
```bash
docker buildx build -t uv-builder -f builder.dockerfile --load .
@ -73,10 +73,10 @@ Please refer to Ruff's [Profiling Guide](https://github.com/astral-sh/ruff/blob/
You can use [tracing-durations-export](https://github.com/konstin/tracing-durations-export) to visualize parallel requests and find any spots where uv is CPU-bound. Example usage, with `uv` and `uv-dev` respectively:
```bash
```shell
RUST_LOG=uv=info TRACING_DURATIONS_FILE=target/traces/jupyter.ndjson cargo run --features tracing-durations-export --profile profiling -- pip compile scripts/requirements/jupyter.in
```
```bash
```shell
RUST_LOG=uv=info TRACING_DURATIONS_FILE=target/traces/jupyter.ndjson cargo run --features tracing-durations-export --bin uv-dev --profile profiling -- resolve jupyter
```