Book: Section on config-description
Dieses Issue hat noch niemand übernommen.
- Vorherrschende Sprache
- Rust
- Sterne
- 1.1k
- Forks
- 122
- Ø Merge
- 10 Std. 37 Min.
- Gemergte PRs (30 T.)
- 2
Beschreibung
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.
Beitragsleitfaden
Für dieses Repository ist kein Beitragsleitfaden indexiert
Erste Schritte
- Lies das ganze Issue und danach den Beitragsleitfaden des Projekts.
- Schreib ins Issue, dass du es übernimmst — das erspart doppelte Arbeit.
- Forke das Repository und arbeite in einem Branch.
- Öffne einen Pull Request, der die Issue-Nummer nennt.
Rechercherichtung
Beginne mit dem Lesen der Diskussion in Pull Request #166, insbesondere des dort referenzierten Kommentars, und prüfe die vorgeschlagene Verwendung der type_description-Crate. Das Issue beschreibt ein umfassendes maschinenlesbares Konzept zur Konfigurationsbeschreibung, anstatt Dateien oder Tests zu benennen. Ein klares Ergebnis würde voraussetzen, dass Umfang und Vorgehensweise vereinbart werden, bevor mit der Implementierung begonnen werden kann.
Vom Indexierungsmodell aus dem Issue-Text verfasst.
Bewertung
- Tech-Stack
- rust
- Bereich
- cli, documentation
- Issue-Typ
- Dokumentation
- Schwierigkeit
- 5/5
- Geschätzter Aufwand
- Über eine Woche
- Aktivitätsstatus
- Veraltet
- Klarheit
- Muss geklärt werden
- Anfängerfreundlichkeit
- 20/100