Hacktoberfest 2026: le issue che i maintainer hanno segnato per ottobre, aperte e adatte ai principianti. Sfoglia le issue Hacktoberfest

docs(surgery): mlxcel-surgery comments still describe shipped work as future

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

Direzione di ricerca

Inizia dai tre commenti di documentazione in src/lib/mlxcel-surgery/src/pipeline.rs:36-37, error.rs:23-24 e lib.rs:77-78. Segui le integrazioni, le varianti degli errori e le esportazioni referenziate per confermarne lo stato distribuito, quindi aggiorna solo la formulazione fuorviante al futuro. Il lavoro è completato quando nessun commento di mlxcel-surgery descrive funzionalità distribuite come future.

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

Descrizione

priority:low status:ready type:docs

Summary

Update three mlxcel-surgery doc comments that describe shipped functionality as "future": the CLI integration, the error variants, and the five concrete ops have all landed.

Background

The comments date from when surgery was scaffolding. Since then the CLI flag, the loader glue, the error variants, and all five ops shipped, so the "future" language now misleads a reader about what exists.

Proposed Solution

Three comment edits, each verifiable by following the reference already in the comment.

Implementation Notes

  • src/lib/mlxcel-surgery/src/pipeline.rs:36-37 says "Used by: future mlxcel::surgery integration glue (CLI flag)". The glue exists (src/surgery.rs) and the flag ships (src/main.rs:329, Cargo.toml:113 on by default).
  • src/lib/mlxcel-surgery/src/error.rs:23-24 says "Variants cover the common failure modes for the future op set (A5-A9)". All three variants are live (ops/add.rs, ops/scale.rs, ops/prune/tensor_ops.rs).
  • src/lib/mlxcel-surgery/src/lib.rs:77-78 says "future concrete ops (A5-A9 - Scale, Add, Prune, Replace, Interpolate)". All five are exported at lib.rs:60 (pub use ops::{AddOp, InterpolateOp, PruneOp, PruneSelector, ReplaceOp, ScaleOp};).
  • Same class as the merged surgery-example cleanup (#1632 / #1643).

Acceptance Criteria

  • No mlxcel-surgery comment describes shipped work as future.

Original Suggestion

Title: docs(surgery): mlxcel-surgery comments still describe shipped work as future

Three mlxcel-surgery doc comments still describe shipped functionality as "future" — the CLI integration, the error variants, and all five concrete ops have long since landed.

Evidence

  • src/lib/mlxcel-surgery/src/pipeline.rs:36-37 — "Used by: future mlxcel::surgery integration glue (CLI flag — A4)"; the glue exists (src/surgery.rs:15-21) and the flag ships (src/main.rs:339, :2623; src/bin/mlx_server.rs:1939; Cargo.toml:113 on by default)
  • src/lib/mlxcel-surgery/src/error.rs:23-24 — "Variants cover the common failure modes for the future op set (A5–A9)"; all three variants are live (ops/add.rs:243,276,303, ops/scale.rs:205,225,233, ops/prune/tensor_ops.rs:47)
  • src/lib/mlxcel-surgery/src/lib.rs:77-78 — "future concrete ops (A5–A9 — Scale, Add, Prune, Replace, Interpolate)"; all five are exported at lib.rs:60

Suggested fix

Three comment edits, each verifiable by following the reference in the comment itself. Same class as the merged surgery-example cleanup (#1632/#1643).

Acceptance criteria

  • No mlxcel-surgery comment describes shipped work as future
Lingua principale
Rust
Stelle
482
Fork
70
Merge medio
7h 2m
PR unite (30g)
367

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 lablup/mlxcel

Tutte le issue di lablup/mlxcel

Issue simili

Altre issue su Rust

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.