Figure out what vimdoc should do in @library functions with undocumented functions.
Aperta
Nessuno ha ancora preso questa issue.
- Lingua principale
- Python
- Stelle
- 306
- Fork
- 30
- Metriche di merge delle PR
- Nessuna PR unita negli ultimi 30g
Descrizione
Should they be presumed @private? Or should they have their signatures put in the helpfile with no explanation? Or should vimdoc complain that they must be explicitly marked @private? Should a warning be issued?
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
L’issue nomina funzioni @library e helpfiles generati, ma non indica alcun punto di ingresso per file o test. Esamina innanzitutto come vimdoc gestisce attualmente le funzioni non documentate, quindi stabilisci la policy prevista; il lavoro sarà completo quando sarà definita una regola chiara per le signature, le annotazioni @private e gli avvisi.
Scritto dal modello di indicizzazione a partire dal testo della issue.
Valutazione
- Stack tecnologico
- python
- Ambito
- documentation
- Tipo di issue
- Funzionalità
- Difficoltà
- 5/5
- Tempo stimato
- Più di una settimana
- Stato di attività
- Ferma
- Chiarezza
- Da chiarire
- Idoneità per principianti
- 25/100