Improve API doc for users
Abierto
Nadie ha tomado este issue todavía.
Documentation
help wanted
task
- Lenguaje dominante
- Python
- Estrellas
- 1.8k
- Forks
- 570
- Merge medio
- 1 d 10 h
- PR fusionados (30 d)
- 24
Descripción
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
Guía de contribución
No hay ninguna guía de contribución indexada para este repositorio
Primeros pasos
- Lee el issue completo y luego la guía de contribución del proyecto.
- Comenta en el issue que vas a ocuparte — evita que dos personas hagan lo mismo.
- Haz un fork del repositorio y trabaja en una rama.
- Abre un pull request que haga referencia al número del issue.
Línea de trabajo
Revisa primero la documentación de la API publicada en https://appium.github.io/python-client-sphinx/ y, a continuación, compárala con los ejemplos de Sphinx y las referencias de Napoleon Config indicados en el issue. Identifica carencias concretas para los usuarios y actualiza la documentación; el trabajo estará terminado cuando la referencia de la API sea más fácil de usar.
Escrito por el modelo de indexación a partir del texto del issue.
Evaluación
- Stack tecnológico
- python
- Área
- documentation
- Tipo de issue
- Documentación
- Dificultad
- 4/5
- Tiempo estimado
- 3-5 días
- Estado de actividad
- Estancado
- Claridad
- Necesita aclaración
- Aptitud para principiantes
- 35/100