rust/lancedb
1
0
Fork 0
mirror of https://github.com/lancedb/lancedb.git synced 2026-10-25 21:22:29 +00:00
Code Issues Packages Projects Releases Wiki Activity

docs: include Rust integration tests in snippet regeneration

Browse Source
This commit is contained in:
Gatefixer
2026-10-25 10:25:30 +00:00
parent 00ae2cdf7a
commit 2a85c0eb9b
1 changed files with 6 additions and 3 deletions
Download Patch File Download Diff File Expand all files Collapse all files
CONTRIBUTING.md
+6 -3
View File
@@ -106,11 +106,14 @@ at the same path when the published site is assembled.
Four things to know before editing:
**Code examples are not written into the pages.** They live in real tests under
`docs/web-tests/{py,ts,rs}`, are extracted into `docs/web/snippets/`, and are
imported by the pages. Edit the test, then regenerate from the repository root:
`docs/web-tests/{py,ts,rs}` and `rust/lancedb/tests`, are extracted into
`docs/web/snippets/`, and are imported by the pages. Edit the test, then
regenerate from the repository root:
```bash
uv run docs/web-tests/mdx_snippets_gen.py -s docs/web-tests/py -s docs/web-tests/ts -s docs/web-tests/rs -o docs/web/snippets
uv run docs/web-tests/mdx_snippets_gen.py \
-s docs/web-tests/py -s docs/web-tests/ts -s docs/web-tests/rs \
-s rust/lancedb/tests -o docs/web/snippets
```
Review the diff before committing: a few modules currently regenerate with