New issue

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

#

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

Already on GitHub? # to your account

Jump to bottom

Improve Documentation for Script Tools Module #2190

Merged

junderw merged 2 commits into bitcoinjs:master from ethsmartcoder:master

Dec 15, 2024

Contributor

ethsmartcoder commented Dec 14, 2024

Changes

Added detailed function comments:

Provided clear explanations for the purpose, parameters, return values, and exceptions for all exported and key internal functions.
Used Typedoc-compatible annotations to facilitate automatic documentation generation.

Removed unclear or outdated comments:

Eliminated comments that were ambiguous or redundant with the code logic.
Ensured the remaining comments are concise, relevant, and directly useful for understanding the code.

ethsmartcoder added 2 commits

December 14, 2024 13:08


          docs: improve code comment

9f9bcbc


          build and test

3d53450

junderw approved these changes

View reviewed changes

junderw merged commit 19d8f72 into bitcoinjs:master

11 checks passed

# for free to join this conversation on GitHub. Already have an account? # to comment

Labels

None yet