Improve API doc for users
Offen
Dieses Issue hat noch niemand übernommen.
Documentation
help wanted
task
- Vorherrschende Sprache
- Python
- Sterne
- 1.8k
- Forks
- 570
- Ø Merge
- 1 T. 10 Std.
- Gemergte PRs (30 T.)
- 24
Beschreibung
The problem
Just published API doc.
https://appium.github.io/python-client-sphinx/
However, it is just first revision and could be more user friendly.
References
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
Überprüfe zuerst die veröffentlichte API-Dokumentation unter https://appium.github.io/python-client-sphinx/ und vergleiche sie anschließend mit den im Issue aufgeführten Sphinx-Beispielen und Napoleon-Config-Referenzen. Identifiziere konkrete benutzerseitige Lücken und aktualisiere die Dokumentation; abgeschlossen ist die Aufgabe, wenn die API-Referenz benutzerfreundlicher ist.
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
- 35/100