Argument Clinic: add reference for the DSL
Ouverte
Personne n'a encore pris cette issue.
type-feature
- Langage dominant
- Python
- Étoiles
- 2.1k
- Forks
- 1k
- Merge moyen
- 2 j 12 h
- PR mergées (30 j)
- 12
Description
We need a better reference for the Argument Clinic DSL:
- legal syntax for the "function name" line
- legal syntax for parameter lines
- legal syntax for docstrings
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 ainsi que toutes les références actuelles au DSL dans le devguide. Comparez la couverture documentée avec la syntaxe demandée pour les noms de fonctions, les lignes de paramètres et les docstrings ; le travail est terminé lorsqu’une référence explique la syntaxe autorisée pour ces trois domaines.
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é
- 3/5
- Temps estimé
- 1-2 jours
- Activité
- À l'abandon
- Clarté
- Plutôt claire
- Accessibilité débutants
- 45/100