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.

Sign up for GitHub

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

Jump to bottom

Improve Documentation for Script Tools Module #2190

Merged
merged 2 commits into from
Dec 15, 2024
Merged

Improve Documentation for Script Tools Module #2190

merged 2 commits into from
Dec 15, 2024

Conversation

ethsmartcoder
Copy link
Contributor

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.

@junderw junderw merged commit 19d8f72 into bitcoinjs:master Dec 15, 2024
11 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@junderw junderw junderw approved these changes

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@ethsmartcoder @junderw