Improve API doc for users
Aperta
Nessuno ha ancora preso questa issue.
Documentation
help wanted
task
- Lingua principale
- Python
- Stelle
- 1.8k
- Fork
- 570
- Merge medio
- 1g 10h
- PR unite (30g)
- 24
Descrizione
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
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
Esamina prima la documentazione API pubblicata all’indirizzo https://appium.github.io/python-client-sphinx/, quindi confrontala con gli esempi Sphinx e i riferimenti a Napoleon Config elencati nell’issue. Individua lacune concrete dal punto di vista dell’utente e aggiorna la documentazione; il lavoro è completato quando il riferimento API è più facile da usare.
Scritto dal modello di indicizzazione a partire dal testo della issue.
Valutazione
- Stack tecnologico
- python
- Ambito
- documentation
- Tipo di issue
- Documentazione
- Difficoltà
- 4/5
- Tempo stimato
- 3-5 giorni
- Stato di attività
- Ferma
- Chiarezza
- Da chiarire
- Idoneità per principianti
- 35/100