Term list /glossary
Personne n'a encore pris cette issue.
Évaluation
- Difficulté
- 3/5
- Temps estimé
- 1-2 jours
- Accessibilité débutants
- 35/100
- Type d'issue
- Documentation
- Clarté
- Plutôt claire
- Activité
- À l'abandon
- Stack technique
- rust
- Domaine
- audio-video-rtc, documentation
Piste de recherche
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.
Rédigé par le modèle d'indexation à partir du texte de l'issue.
Description
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
Sinkstruct.
- Langage dominant
- Rust
- Étoiles
- 2.5k
- Forks
- 338
- Merge moyen
- 1 j 3 h
- PR mergées (30 j)
- 1
Préparer son environnement
- Aucun Dockerfile ni fichier Docker Compose
- Aucun modèle de pull request
- Lire le guide de contribution
Par où commencer
- Lisez l'issue en entier, puis le guide de contribution du projet.
- Signalez en commentaire que vous la prenez — cela évite que deux personnes fassent le même travail.
- Forkez le dépôt et travaillez sur une branche.
- Ouvrez une pull request qui référence le numéro de l'issue.
Autres issues de RustAudio/rodio
-
bug
Difficulté 2/5 1-3 heures Accessibilité débutants 74/100
-
Difficulté 1/5 Moins d'une heure Accessibilité débutants 73/100
-
Difficulté 3/5 1-2 jours Accessibilité débutants 62/100
-
WavDecoder::size_hint underflows (u32 wrap, ~4.29e9) after EOF, causes multi-GB Vec::collect() allocationPeut-être pris @marin-m l’a pris il y a 5 jours. Ouverte
Difficulté 3/5 1-2 jours Accessibilité débutants 72/100
-
Difficulté 4/5 3-5 jours Accessibilité débutants 45/100
Toutes les issues de RustAudio/rodio
Issues similaires
-
bug priority: low ui
Difficulté 2/5 1-3 heures Accessibilité débutants 65/100
storytold/photocraft#10370 · 1 commentaire ·
Les mainteneurs répondent en général sous 1 jour
-
area:doc bug in progress needs-triage
Difficulté 2/5 1-3 heures Accessibilité débutants 72/100
bherbruck/solvecraft#9634 · 2 commentaires · 1 réaction ·
-
inflate: total_in uses plain += on c_ulong (32-bit on Windows), panics in debug for streams > 4 GiBOuverte
Difficulté 1/5 Moins d'une heure Accessibilité débutants 85/100
trifectatechfoundation/zlib-rs#570 · 1 commentaire ·
-
bug discord-triage
Difficulté 2/5 1-3 heures Accessibilité débutants 84/100
LanternOps/breeze#10755 ·
Les mainteneurs répondent en général sous 1 jour
-
Difficulté 2/5 1-3 heures Accessibilité débutants 65/100
aranya-project/aranya#803 ·