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

Enhance Documentation Using JSDoc/TsDoc Standards #444

Open
h0ngcha0 opened this issue Nov 14, 2024 · 0 comments
Open

Enhance Documentation Using JSDoc/TsDoc Standards #444

h0ngcha0 opened this issue Nov 14, 2024 · 0 comments

Comments

@h0ngcha0
Copy link
Member

The SDK codebase would benefit from consistent, high-quality documentation to improve maintainability, ease of use, and on-boarding for new developers. To achieve this, we propose adopting JSDoc and/or TSDoc standards throughout the project. This will provide a standardized way to document functions, classes, parameters, return types, and modules, making it easier to generate comprehensive, up-to-date documentation.

Please start with the web3 package.

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

No branches or pull requests

1 participant