Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: improve doc of LockScriptInfo #554

Merged
merged 2 commits into from
Sep 1, 2023

Conversation

doitian
Copy link
Contributor

@doitian doitian commented Aug 31, 2023

Description

Improve the documentation of registering LockScriptInfo for custom lock
scripts.

Full example can be found here:

https://github.com/doitian/ckb-sdk-examples/blob/main/examples/custom-script/README.js.md

Type of change

Please delete options that are not relevant.

  • Documentation or Website
  • Example

How Has This Been Tested?

  • pnpm run build && pnpm run lint
  • pnpm run docs

Improve the documentation of registering LockScriptInfo for custom lock
scripts.

Full example can be found here:

https://github.com/doitian/ckb-sdk-examples/blob/main/examples/custom-script/README.js.md
@vercel
Copy link

vercel bot commented Aug 31, 2023

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Updated (UTC)
lumos-website ✅ Ready (Inspect) Visit Preview Aug 31, 2023 10:34am

@doitian
Copy link
Contributor Author

doitian commented Aug 31, 2023

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Updated (UTC)
lumos-website ✅ Ready (Inspect) Visit Preview Aug 31, 2023 7:07am

https://lumos-website-git-fork-doitian-custom-script-doc-magickbase.vercel.app/api/interfaces/_ckb_lumos_common_scripts.LockScriptInfo.html

@codecov
Copy link

codecov bot commented Aug 31, 2023

Codecov Report

Merging #554 (d8fff6f) into develop (1cb43fe) will increase coverage by 0.03%.
The diff coverage is 100.00%.

Impacted file tree graph

@@             Coverage Diff             @@
##           develop     #554      +/-   ##
===========================================
+ Coverage    86.62%   86.65%   +0.03%     
===========================================
  Files          115      115              
  Lines        23045    23102      +57     
  Branches      2330     2333       +3     
===========================================
+ Hits         19962    20019      +57     
  Misses        3040     3040              
  Partials        43       43              
Files Changed Coverage Δ
packages/common-scripts/src/common.ts 89.44% <100.00%> (+0.53%) ⬆️
packages/common-scripts/src/index.ts 100.00% <100.00%> (ø)

Continue to review full report in Codecov by Sentry.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 1cb43fe...d8fff6f. Read the comment docs.

…m_lock_script_info.ts

Co-authored-by: Yonghui Lin <[email protected]>
Signed-off-by: ian <[email protected]>
@homura homura merged commit ed5dc56 into ckb-js:develop Sep 1, 2023
5 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants