Docs: further worked contextual tutorial examples
Dieses Issue hat noch niemand übernommen.
- Vorherrschende Sprache
- Python
- Sterne
- 150
- Forks
- 23
- Ø Merge
- 1 T. 11 Std.
- Gemergte PRs (30 T.)
- 2
Beschreibung
Quoting @bnlawrence in an external conversation thread at a point concerning the necessary terseness of the documentation:
I think the API docs are fine, we just need more tultorials working through real examples. If we can get the indexing right that puts context on the abstraction and terseness necessary in the API.
Beitragsleitfaden
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
Es werden keine Dateien, Tests oder Einstiegspunkte genannt. Prüfe zuerst die vorhandene Dokumentation und die Tutorials, identifiziere dann echte kontextbezogene Beispiele und wie der Dokumentationsindex auf sie verweisen sollte. Als erledigt gilt, dass die ausgearbeiteten Beispiele hinzugefügt und indiziert sind, aber das Issue legt weder ihre Anzahl noch ihren Umfang fest.
Vom Indexierungsmodell aus dem Issue-Text verfasst.
Bewertung
- Tech-Stack
- python
- Bereich
- documentation
- Issue-Typ
- Dokumentation
- Schwierigkeit
- 4/5
- Geschätzter Aufwand
- 3-5 Tage
- Aktivitätsstatus
- Veraltet
- Klarheit
- Muss geklärt werden
- Anfängerfreundlichkeit
- 25/100