CodeChain-io / CodeChain-io/codechain-sdk-js
SDK documentation does not parse `createStoreTransaction`'s argument well
- Linguagem predominante
- TypeScript
- Estrelas
- 26
- Forks
- 14
- Métricas de merge de PRs
- Nenhum PR com merge em 30d
Descrição
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
Guia de contribuição
Nenhum guia de contribuição indexado para este repositório
Direção de pesquisa
Comece localizando a declaração TypeScript e a documentação de createStoreTransaction e, em seguida, compare-as com a página de API gerada vinculada na issue. Atualize a fonte da documentação para que o tipo de params e os detalhes disponíveis correspondam aos comentários do código e verifique se a documentação renderizada do SDK exibe as informações corrigidas dos argumentos.
Escrita pelo modelo de indexação a partir do texto da issue.
Avaliação
- Stack de tecnologia
- typescript
- Domínio
- documentation
- Tipo de issue
- Documentação
- Dificuldade
- 2/5
- Tempo estimado
- 1-3 horas
- Status de atividade
- Estagnada
- Clareza
- Razoavelmente clara
- Facilidade para iniciantes
- 45/100