ConvenientPatch#hunks documentation is incorrect
Aperta
Nessuno ha ancora preso questa issue.
- Lingua principale
- JavaScript
- Stelle
- 5.8k
- Fork
- 704
- Metriche di merge delle PR
- Nessuna PR unita negli ultimi 30g
Descrizione
The documentation at https://www.nodegit.org/api/convenient_patch/#hunks indicates that the return of hunks is an Array<ConvenientHunk>.
However, there is no such type as ConvenientHunk. It is not clear what hunks() actually returns.
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 di ConvenientPatch#hunks nella pagina API collegata, quindi individua l’implementazione o la definizione API di hunks() per determinare il suo tipo di ritorno effettivo. Aggiorna la documentazione in modo che utilizzi il tipo corretto e verifica che la pagina API generata non faccia più riferimento a ConvenientHunk.
Scritto dal modello di indicizzazione a partire dal testo della issue.
Valutazione
- Stack tecnologico
- javascript
- Ambito
- documentation
- Tipo di issue
- Documentazione
- Difficoltà
- 2/5
- Tempo stimato
- 1-3 ore
- Stato di attività
- Ferma
- Chiarezza
- Da chiarire
- Idoneità per principianti
- 35/100