Book: Section on config-description
Nessuno ha ancora preso questa issue.
- Lingua principale
- Rust
- Stelle
- 1.1k
- Fork
- 122
- Merge medio
- 10h 37m
- PR unite (30g)
- 2
Descrizione
As requested in https://github.com/rust-cli/book/pull/166#discussion_r972045274 I'd like to open up a discussion about config description.
The general idea of what I call "config description" here is that a given configuration type can describe itself in a machine-readable way, which can ultimatively be rendered to user-documentation.
A user would ask the program "tell me how I can configure you?" and the program is then able to tell the user "I get configured via the following settings: 'greeting_message', which has to be a String, 'repeat', which has to be a number greater than zero".
A possible solution for this is sketched out in #166 using the type_description crate.
Guida per i contributori
Nessuna guida per i contributori indicizzata per questo repository
Come iniziare
- Leggi tutta la issue e poi la guida ai contributi del progetto.
- Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
- Fai un fork del repository e lavora su un branch.
- Apri una pull request che faccia riferimento al numero della issue.
Direzione di ricerca
Inizia leggendo la discussione nella pull request #166, in particolare il commento indicato, e rivedi l’uso proposto della crate type_description. L’issue descrive un concetto ampio di descrizione della configurazione leggibile dalle macchine, invece di indicare file o test. Per ottenere un risultato chiaro sarebbe necessario concordare l’ambito e l’approccio prima di poter iniziare l’implementazione.
Scritto dal modello di indicizzazione a partire dal testo della issue.
Valutazione
- Stack tecnologico
- rust
- Ambito
- cli, documentation
- Tipo di issue
- Documentazione
- Difficoltà
- 5/5
- Tempo stimato
- Più di una settimana
- Stato di attività
- Ferma
- Chiarezza
- Da chiarire
- Idoneità per principianti
- 20/100