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

Term list /glossary

Aperta
  • Qualcosa non va?
#652 12 commenti 0 reazioni 0 assegnatari Vedi su GitHub

Nessuno ha ancora preso questa issue.

Valutazione

Difficoltà
3/5
Tempo stimato
1-2 giorni
Idoneità per principianti
35/100
Tipo di issue
Documentazione
Chiarezza
Abbastanza chiara
Stato di attività
Ferma
Stack tecnologico
rust
Ambito
audio-video-rtc, documentation

Direzione di ricerca

Start by reading the glossary and documentation structure in the Rodio repository; the issue does not name specific files or tests. Identify terms for audio pipeline or tree steps, their relationships, and what consumes them, then add a glossary section that helps contributors use those terms consistently.

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

Descrizione

enhancement

Rodio has more contributors 🎉 and the maintenance team is growing stronger 🥳. Communication and documentation efforts are harder then they have to be because we do not have words for every concept in rodio.

My goal is to build a glossary (specialized term list) and make that part of the documentation. We could make the docs link to that glossary each time one of its specialized terms is used.

It seems most urgent to get some words around the audio... pipelines?:

let thing = Decoder::new("path").amplify().pausable()

what do we call each of these steps and how they relate to each-other?

Lets give the steps names so we can discuss this more easily:

let decoder = Decoder::new();
let amplified = decoder.amplify();
let pausable = amplified.pausable();

This is an audio pipeline, but it could also be an audio tree (if we introduce mix). I think we need a words for

  • the thing that generates the samples on one end of the pipeline/tree. Maybe it should be called the generator?
  • referring to an earlier or later step in the pipeline/tree. Concretely is pausable, which is applied after amplify, the parent of amplify or its child? Maybe some other word works? And what is called the other way round?
  • things that these pipelines are fed to. When this pipeline is consumed by something, what do we call it? consumer? It could also be called a Sink as that word will be freed up once we deprecate the Sink struct.
Lingua principale
Rust
Stelle
2.5k
Fork
338
Merge medio
1g 3h
PR unite (30g)
1

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 RustAudio/rodio

Tutte le issue di RustAudio/rodio

Issue simili

Altre issue su Rust

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.