CodeChain-io / CodeChain-io/codechain-sdk-js
SDK documentation does not parse `createStoreTransaction`'s argument well
- Vorherrschende Sprache
- TypeScript
- Sterne
- 26
- Forks
- 14
- PR-Merge-Kennzahlen
- Keine gemergten PRs in 30 T.
Beschreibung
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
Beitragsleitfaden
Für dieses Repository ist kein Beitragsleitfaden indexiert
Rechercherichtung
Beginne damit, die TypeScript-Deklaration und Dokumentation für createStoreTransaction zu finden, und vergleiche sie anschließend mit der im Issue verlinkten generierten API-Seite. Aktualisiere die Dokumentationsquelle, sodass der Parametertyp und die verfügbaren Details mit den Code-Kommentaren übereinstimmen, und überprüfe, dass die gerenderte SDK-Dokumentation die korrigierten Argumentinformationen anzeigt.
Vom Indexierungsmodell aus dem Issue-Text verfasst.
Bewertung
- Tech-Stack
- typescript
- Bereich
- documentation
- Issue-Typ
- Dokumentation
- Schwierigkeit
- 2/5
- Geschätzter Aufwand
- 1-3 Stunden
- Aktivitätsstatus
- Veraltet
- Klarheit
- Größtenteils klar
- Anfängerfreundlichkeit
- 45/100