Plugin documentation is a little lacking
Nessuno ha ancora preso questa issue.
- Lingua principale
- Python
- Stelle
- 20.6k
- Fork
- 3.3k
- Metriche di merge delle PR
- Metriche PR in attesa
Descrizione
Ideally it should be possible to use the interface without having to dig through the source code, but that's not really possible. The docs mention that the callbacks returned by the hooks will receive APIs, but don't explain what those APIs are at all. It should also be mentioned that get_additional_deps has a different interface to the other plugin functions, and this detail should appear in the docs as well.
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 dalla documentazione esistente dei plugin, in particolare dalle sezioni che descrivono i callback degli hook e get_additional_deps. Documenta le API passate ai callback e spiega in che modo get_additional_deps differisce dalle altre funzioni dei plugin. Il lavoro è completato quando gli utenti possono comprendere queste interfacce senza leggere il codice sorgente.
Scritto dal modello di indicizzazione a partire dal testo della issue.
Valutazione
- Stack tecnologico
- python
- Ambito
- documentation
- Tipo di issue
- Documentazione
- Difficoltà
- 2/5
- Tempo stimato
- 1-3 ore
- Stato di attività
- Ferma
- Chiarezza
- Abbastanza chiara
- Idoneità per principianti
- 50/100