CodeChain-io / CodeChain-io/codechain-sdk-js
SDK documentation does not parse `createStoreTransaction`'s argument well
- Lingua principale
- TypeScript
- Stelle
- 26
- Fork
- 14
- Metriche di merge delle PR
- Nessuna PR unita negli ultimi 30g
Descrizione
The type of params in the createStoreTransaction in the document is `object | object`.
But the code has much information in the comments and the type is not object:
link: https://api.codechain.io/2.0.1/classes/core.html#createstoretransaction
Guida per i contributori
Nessuna guida per i contributori indicizzata per questo repository
Direzione di ricerca
Inizia individuando la dichiarazione TypeScript e la documentazione di createStoreTransaction, quindi confrontale con la pagina API generata collegata nell’issue. Aggiorna la sorgente della documentazione in modo che il tipo di params e i dettagli disponibili corrispondano ai commenti nel codice, quindi verifica che la documentazione SDK renderizzata mostri le informazioni corrette sugli argomenti.
Scritto dal modello di indicizzazione a partire dal testo della issue.
Valutazione
- Stack tecnologico
- typescript
- Ambito
- documentation
- Tipo di issue
- Documentazione
- Difficoltà
- 2/5
- Tempo stimato
- 1-3 ore
- Stato di attività
- Ferma
- Chiarezza
- Abbastanza chiara
- Idoneità per principianti
- 45/100