CodeChain-io / CodeChain-io/codechain-sdk-js
SDK documentation does not parse `createStoreTransaction`'s argument well
- Lenguaje dominante
- TypeScript
- Estrellas
- 26
- Forks
- 14
- Métricas de merge de PR
- Sin PR fusionados en 30 d
Descripción
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
Guía de contribución
No hay ninguna guía de contribución indexada para este repositorio
Línea de trabajo
Comienza localizando la declaración de TypeScript y la documentación de createStoreTransaction, y luego compárala con la página de API generada enlazada en el issue. Actualiza la fuente de documentación para que el tipo de params y los detalles disponibles coincidan con los comentarios del código, y verifica que la documentación renderizada del SDK muestre la información corregida de los argumentos.
Escrito por el modelo de indexación a partir del texto del issue.
Evaluación
- Stack tecnológico
- typescript
- Área
- documentation
- Tipo de issue
- Documentación
- Dificultad
- 2/5
- Tiempo estimado
- 1-3 horas
- Estado de actividad
- Estancado
- Claridad
- Bastante claro
- Aptitud para principiantes
- 45/100