Improve API doc for users
Ouverte
Personne n'a encore pris cette issue.
Documentation
help wanted
task
- Langage dominant
- Python
- Étoiles
- 1.8k
- Forks
- 570
- Merge moyen
- 1 j 10 h
- PR mergées (30 j)
- 24
Description
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
Guide de contribution
Aucun guide de contribution indexé pour ce dépôt
Par où commencer
- Lisez l'issue en entier, puis le guide de contribution du projet.
- Signalez en commentaire que vous la prenez — cela évite que deux personnes fassent le même travail.
- Forkez le dépôt et travaillez sur une branche.
- Ouvrez une pull request qui référence le numéro de l'issue.
Piste de recherche
Examinez d’abord la documentation publiée de l’API à l’adresse https://appium.github.io/python-client-sphinx/, puis comparez-la aux exemples Sphinx et aux références de Napoleon Config indiqués dans l’issue. Identifiez les lacunes concrètes auxquelles sont confrontés les utilisateurs et mettez à jour la documentation ; le travail est terminé lorsque la référence de l’API est plus conviviale.
Rédigé par le modèle d'indexation à partir du texte de l'issue.
Évaluation
- Stack technique
- python
- Domaine
- documentation
- Type d'issue
- Documentation
- Difficulté
- 4/5
- Temps estimé
- 3-5 jours
- Activité
- À l'abandon
- Clarté
- À clarifier
- Accessibilité débutants
- 35/100