MerginMaps / MerginMaps/python-api-client
Add example to the command lines
Ouverte
Personne n'a encore pris cette issue.
enhancement
good first issue
- Langage dominant
- Python
- Étoiles
- 23
- Forks
- 12
- Merge moyen
- 2 j 13 h
- PR mergées (30 j)
- 7
Description
I am struggling to use most of the command lines reading the help files. Like most terminal commands, I prefer to look at examples!
Guide de contribution
Ouvrir le guide de contribution
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
Commencez par examiner les fichiers d'aide de la ligne de commande et identifier les commandes qui ne comportent pas d'exemples d'utilisation. Ajoutez des exemples pratiques pour les commandes couvertes par la demande, puis vérifiez que la sortie de l'aide montre clairement comment chaque commande s'utilise.
Rédigé par le modèle d'indexation à partir du texte de l'issue.
Évaluation
- Stack technique
- python
- Domaine
- cli, documentation
- Type d'issue
- Documentation
- Difficulté
- 3/5
- Temps estimé
- 1-2 jours
- Activité
- À l'abandon
- Clarté
- À clarifier
- Accessibilité débutants
- 30/100