Update documentation to use generators
Offen
- Vorherrschende Sprache
- Python
- Sterne
- 104
- Forks
- 33
- PR-Merge-Kennzahlen
- Keine gemergten PRs in 30 T.
Beschreibung
The current documentation assumes that the output format is a list, but CLI Helpers now returns generators. We should update the quick start and the API documentation.
Beitragsleitfaden
Rechercherichtung
Beginne mit dem Lesen der Abschnitte zur quick-start- und API-Dokumentation, die die Ausgabe von CLI Helpers als Liste beschreiben. Aktualisiere diese Verweise so, dass sie Generatoren beschreiben, und überprüfe anschließend, dass beide Dokumentationsbereiche das aktuelle Verhalten konsistent widerspiegeln.
Vom Indexierungsmodell aus dem Issue-Text verfasst.
Bewertung
- Tech-Stack
- python
- Bereich
- cli, documentation
- Issue-Typ
- Dokumentation
- Schwierigkeit
- 2/5
- Geschätzter Aufwand
- 1-3 Stunden
- Aktivitätsstatus
- Veraltet
- Klarheit
- Größtenteils klar
- Anfängerfreundlichkeit
- 45/100