docs: adapter READMEs and CONTRIBUTING describe a runtime API that no longer exists

Aperta Adatta ai principianti
  • Qualcosa non va?
#456 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
78/100
Tipo di issue
Documentazione
Chiarezza
Specificata chiaramente
Stato di attività
Attiva
Stack tecnologico
rust
Ambito
documentation

Direzione di ricerca

Leggi le sezioni interessate in aimdb-tokio-adapter/README.md, aimdb-embassy-adapter/README.md, aimdb-core/README.md e CONTRIBUTING.md, quindi confrontale con aimdb-core/src/executor.rs e con i membri del workspace nel Cargo.toml radice. Aggiorna i riferimenti obsoleti all’API e alla struttura del progetto e rimuovi le sezioni sull’avvio dei task se questa funzionalità non esiste più. Il lavoro è completo quando la documentazione corrisponde all’API e al workspace attuali; valuta se make readme-check dovrebbe includere i README di ogni crate.

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

Descrizione

documentation

Problem

Several READMEs still document the runtime abstraction as it was before the Spawn trait and the aimdb-executor crate were removed. The runtime contract is now RuntimeOps in aimdb-core/src/executor.rs; there is no RuntimeAdapter trait, no Spawn trait and no aimdb-executor crate in the workspace.

Stale references found:

File Line(s) What it says
aimdb-tokio-adapter/README.md 61–63 impl RuntimeAdapter for TokioAdapter
aimdb-tokio-adapter/README.md 166–170 "Spawn background tasks using the Spawn trait", use aimdb_executor::Spawn;
aimdb-tokio-adapter/README.md 223 use aimdb_executor::{ExecutorError, ExecutorResult, Spawn};
aimdb-embassy-adapter/README.md 114–116 impl RuntimeAdapter for EmbassyAdapter
aimdb-embassy-adapter/README.md 248 use aimdb_executor::{ExecutorError, ExecutorResult};
aimdb-core/README.md 187 "Core consumes the runtime through aimdb-executor's dyn-safe RuntimeOps"
CONTRIBUTING.md 223 project structure lists aimdb-executor/; line 227 calls tools/aimdb-cli/ a "skeleton"

The snippets in the two adapter READMEs would not compile against the current crates.

Suggested work

  • Rewrite the affected sections against the current API (RuntimeOps, aimdb_core::executor::{ExecutorError, ExecutorResult}), or delete sections whose feature is gone (task spawning).
  • Refresh the project-structure block in CONTRIBUTING.md to match the workspace members in the root Cargo.toml.
  • Consider extending make readme-check to cover the per-crate READMEs so these snippets are compiled in CI; today it evidently does not catch them.

Notes

Found by static inspection (grep against the tree at d9c7be0); I did not try to compile the snippets.

Lingua principale
Rust
Stelle
101
Fork
20
Merge medio
2h 33m
PR unite (30g)
90

Preparare l'ambiente

Apri in Codespaces

Avvia il container di sviluppo del progetto nel browser, con il tuo account GitHub.

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 aimdb-dev/aimdb

Tutte le issue di aimdb-dev/aimdb

Issue simili

Altre issue su Rust

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.