Argument Clinic: add reference for the DSL
Aperta
Nessuno ha ancora preso questa issue.
type-feature
- Lingua principale
- Python
- Stelle
- 2.1k
- Fork
- 1k
- Merge medio
- 2g 12h
- PR unite (30g)
- 12
Descrizione
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
Guida per i contributori
Apri la guida per i contributori
Come iniziare
- Leggi tutta la issue e poi la guida ai contributi del progetto.
- Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
- Fai un fork del repository e lavora su un branch.
- Apri una pull request che faccia riferimento al numero della issue.
Direzione di ricerca
Inizia individuando la documentazione esistente di Argument Clinic e tutti i riferimenti attuali al DSL nel devguide. Confronta la copertura documentata con la sintassi richiesta per i nomi delle funzioni, le righe dei parametri e le docstring; il lavoro è completato quando un riferimento spiega la sintassi valida per tutte e tre le aree.
Scritto dal modello di indicizzazione a partire dal testo della issue.
Valutazione
- Stack tecnologico
- python
- Ambito
- documentation
- Tipo di issue
- Documentazione
- Difficoltà
- 3/5
- Tempo stimato
- 1-2 giorni
- Stato di attività
- Ferma
- Chiarezza
- Abbastanza chiara
- Idoneità per principianti
- 45/100