Docs describe things the code does not do: watermark-driven spill demotion, a throughput metric, a missing test file, CUDA never having run, PyO3 bindings

Aperta Adatta ai principianti
  • Qualcosa non va?
#132 0 commenti 0 reazioni 0 assegnatari Vedi su GitHub

I maintainer di solito rispondono entro 1 giorno

Nessuno ha ancora preso questa issue.

Valutazione

Difficoltà
2/5
Tempo stimato
1-3 ore
Idoneità per principianti
76/100
Tipo di issue
Documentazione
Chiarezza
Specificata chiaramente
Stato di attività
Attiva
Stack tecnologico
rust
Ambito
documentation

Direzione di ricerca

Leggi le affermazioni elencate in docs/SPEC.md, docs/roadmap.md, docs/architecture.md, docs/verification.md e la descrizione pubblicata di oxidelake-api; confrontale con STATUS e con l’implementazione attuale. Esamina i test esistenti in tests/ per decidere a cosa dovrebbe fare riferimento crates/oxidelake-storage/src/uring.rs. Il lavoro è concluso quando ogni affermazione corrisponde al codice e la matrice di STATUS concorda con docs/verification.md.

Scritto dal modello di indicizzazione a partire dal testo della issue.

Descrizione

documentation good first issue

Today — each verified against the code:

  1. docs/SPEC.md (~60), docs/roadmap.md (~30) and docs/architecture.md (~68) describe watermark-driven asynchronous demotion and a throughput metric for the spill manager; the code demotes inline as soon as the budget is exceeded and has no throughput counter (#25 already says the manager is library-only).
  2. crates/oxidelake-storage/src/uring.rs (~100) cites tests/uring_signals.rs, which does not exist (tests/ holds object_store_conformance.rs and pruning.rs).
  3. docs/verification.md (~111-129) still says "Two dev boxes so far", "never claim" CUDA execution and "no such box has run this yet", although STATUS records the 2026-09-06 T4 session.
  4. oxidelake-api's published description says "(PyO3 bindings optional)"; the python feature is deferred (STATUS).

Fix — make each sentence true; point uring.rs at the test that does exist (or add it).

Done when — each item is corrected and STATUS's matrix and verification.md agree.

Found in the 0.3.0 review; published 0.2.0 has the same code.

Lingua principale
Rust
Stelle
1
Fork
2
Merge medio
5g 22h
PR unite (30g)
4

Preparare l'ambiente

Come iniziare

  1. Leggi tutta la issue e poi la guida ai contributi del progetto.
  2. Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
  3. Fai un fork del repository e lavora su un branch.
  4. Apri una pull request che faccia riferimento al numero della issue.

Altre issue di vyncint/oxidelake

Tutte le issue di vyncint/oxidelake

Issue simili

Altre issue su Rust

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.