CodeChain-io / CodeChain-io/codechain-sdk-js

SDK documentation does not parse `createStoreTransaction`'s argument well

未關閉
#409 0 則留言 0 個 reaction 已指派 0 人 在 GitHub 檢視
主要語言
TypeScript
星號
26
分支
14
PR 合併指標
30 天內沒有已合併 PR

描述

The type of params in the createStoreTransaction in the document is `object | object`.

![image](https://user-images.githubusercontent.com/709900/92458718-be9b6c00-f200-11ea-927d-542159dd8e06.png)

But the code has much information in the comments and the type is not object:

![image](https://user-images.githubusercontent.com/709900/92459044-2651b700-f201-11ea-8a4c-ed343e14e036.png)

link: https://api.codechain.io/2.0.1/classes/core.html#createstoretransaction

貢獻指南

這個儲存庫沒有索引到貢獻指南

研究方向

首先定位 createStoreTransaction 的 TypeScript 宣告和文件,然後將其與 issue 中連結的產生 API 頁面進行比較。更新文件來源,使 params 類型和可用詳細資訊與程式碼註解一致,並驗證轉譯後的 SDK 文件顯示了修正後的引數資訊。

由索引模型根據 Issue 內容生成。

評估

技術堆疊
typescript
領域
documentation
Issue 類型
文件
難度
2/5
預估耗時
1-3 小時
活躍度
停滯
描述清晰度
基本清楚
新手友好度
45/100

把新 issue 寄到你的電子郵件信箱

精選適合新手參與的 GitHub issue 摘要。