Skip to content

Commit 425c9ac

Browse files
committed
docs: stop naming an artifact the package no longer produces
The consumer test on pixi 0.78.0 built 'lib/mojo/wgpu.mojoc' -- pixi-build-mojo has followed the CLI rename, so every doc promising 'wgpu.mojopkg' now names a file a current user will not find in their environment. The extension was never the point in any of these sentences, so they now say 'the compiled wgpu package' instead. That reads correctly on both the old and new backends, which matters because consume.yml deliberately still exercises the old pinned end of the pixi range.
1 parent 8dc4ba3 commit 425c9ac

5 files changed

Lines changed: 7 additions & 7 deletions

File tree

‎README.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -58,7 +58,7 @@ preview = ["pixi-build"]
5858
pixi add --git https://github.com/Hundo1018/wgpu-mojo wgpu-mojo
5959
```
6060

61-
This builds `wgpu.mojopkg` and installs it into your environment.
61+
This builds the compiled `wgpu` package and installs it into your environment.
6262

6363
### 3 · Install the native GPU library (once per machine)
6464

‎docs/CI_CD.md‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -135,7 +135,7 @@ pixi run test-compute
135135
## Releasing a version
136136

137137
The package is published as a self-contained `.conda` (it bundles `libwgpu_native`,
138-
the compiled C bridges, and `wgpu.mojopkg`) built from
138+
the compiled C bridges, and the compiled `wgpu` package) built from
139139
[conda.recipe/recipe.yaml](../conda.recipe/recipe.yaml) with rattler-build.
140140

141141
1. Bump the version in **both** [pixi.toml](../pixi.toml) and
@@ -163,7 +163,7 @@ pixi exec rattler-build build \
163163
## Two build mechanisms (don't conflate them)
164164

165165
- **`pixi-build-mojo`** (configured under `[package.build]` in `pixi.toml`) is what
166-
`pixi add --git`/`--path` triggers. It packages **only `wgpu.mojopkg`** — it does
166+
`pixi add --git`/`--path` triggers. It packages **only the compiled `wgpu` package** — it does
167167
**not** bundle native `.so` files, so consumers still run `setup-native.sh`. This is
168168
the path `consume.yml` exercises and the README documents.
169169

‎tests/integration/consumer/pixi.toml‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@ mojo = ">=1.0.0,<2"
2222

2323
[tasks]
2424
# Compile-only assertion: proves `from wgpu import …` resolves against the
25-
# installed wgpu.mojopkg. Needs no native .so files, so it runs on every OS.
25+
# installed wgpu package. Needs no native .so files, so it runs on every OS.
2626
check = "mojo build app.mojo -o /dev/null"
2727
# Runtime assertion: actually constructs GPU objects. Requires the native
2828
# runtime libs (run setup-native.sh first) and a Vulkan/Metal adapter.

‎wgpu/__init__.mojo‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -94,5 +94,5 @@ from wgpu.descriptors import BGL
9494
from wgpu._core.session import Session
9595
from wgpu._core.wgpu_native.buffer import MappedBuffer
9696

97-
# API discovery (works from .mojopkg without source access)
97+
# API discovery (works from a compiled package without source access)
9898
from wgpu.api_index import api_index

‎wgpu/api_index.mojo‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
Human-readable index of the public wgpu API surface.
33
44
Call api_index() to get a structured text listing every symbol exported by
5-
the wgpu package. Useful for consumers who only have the compiled .mojopkg
5+
the wgpu package. Useful for consumers who only have the compiled package
66
and cannot browse source files.
77
88
Example::
@@ -19,7 +19,7 @@ def api_index() -> String:
1919
category and listed alphabetically within each group.
2020
2121
This is intentionally a static listing (not reflection-based) so it
22-
works identically from source and from a compiled .mojopkg.
22+
works identically from source and from a compiled package.
2323
"""
2424
return """wgpu-mojo public API index (wgpu-native ABI: v29.0.0.0)
2525
================================================================

0 commit comments

Comments
 (0)