Argument Clinic: add reference for all directives
Personne n'a encore pris cette issue.
- Langage dominant
- Python
- Étoiles
- 2.1k
- Forks
- 1k
- Merge moyen
- 2 j 12 h
- PR mergées (30 j)
- 12
Description
We need a good reference for all Argument Clinic directives (@getter, output, etc.). Some of the directives accept one or more parameters; perhaps we can use typical CLI documentation for inspiration (@critical_section [arg1] [arg2]).
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 localiser la documentation existante d'Argument Clinic et les définitions actuelles des directives. Dressez l'inventaire de toutes les directives, y compris celles qui acceptent des paramètres, et comparez leur syntaxe avec l'exemple de style CLI de l'issue. Le travail est terminé lorsque le devguide fournit une référence claire couvrant chaque directive et ses paramètres acceptés.
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é
- Plutôt claire
- Accessibilité débutants
- 35/100