Skip to content

Commit 794508a

Browse files
committed
Fix contrib instructions
1 parent ec5af11 commit 794508a

2 files changed

Lines changed: 7 additions & 11 deletions

File tree

.gitignore

Lines changed: 0 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -95,10 +95,6 @@ ENV/
9595
# PyCharm
9696
.idea
9797

98-
# Meson build artifacts
99-
builddir/
100-
subprojects/
101-
10298
# pixi environments
10399
.pixi/*
104100
*.egg-info

docs/contributing.rst

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -113,17 +113,17 @@ Setting up with uv (recommended)
113113
"""""""""""""""""""""""""""""""""
114114

115115
`uv <https://docs.astral.sh/uv/>`_ is a fast Python package manager. First,
116-
bootstrap the build dependencies, then sync the project::
116+
bootstrap the build dependencies, then install numcodecs in editable mode::
117117

118118
$ uv venv
119119
$ uv pip install --group dev
120-
$ uv sync --group dev --extra test --extra msgpack
120+
$ uv pip install --no-build-isolation -e ".[test,test_extras,msgpack]"
121121

122122
The first ``uv pip install`` step bootstraps the build tools into the virtualenv.
123-
``uv sync`` then builds numcodecs in editable mode (without build isolation, so
124-
the venv's ``ninja`` is used for auto-rebuild on import). This two-step bootstrap
125-
is needed because meson-python editable installs require build tools at runtime,
126-
not just at build time.
123+
The second installs numcodecs in editable mode without build isolation (so the
124+
venv's build tools are used). This two-step process is needed because
125+
meson-python editable installs require build tools at runtime for auto-rebuild
126+
on import.
127127

128128
To run the tests::
129129

@@ -167,7 +167,7 @@ Rebuilding after changes
167167
With an editable install, meson-python automatically rebuilds changed C/Cython
168168
extensions when you import ``numcodecs``. If you need a full clean rebuild::
169169

170-
$ rm -rf builddir
170+
$ rm -rf build
171171
$ pip install --no-build-isolation -e .
172172

173173
Creating a branch

0 commit comments

Comments
 (0)