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

Feat: Add comprehensive JSDoc documentation for all functions and tests and README #1

Merged
merged 20 commits into from
Aug 7, 2024

Conversation

juliopavila
Copy link
Contributor

@juliopavila juliopavila commented Aug 5, 2024

Description:

This pull request adds comprehensive JSDoc documentation to various parts of the codebase, including internal functions, deployment scripts, and test cases. The documentation follows the JSDoc standard and provides detailed descriptions of parameters, return values, and exceptions for each function.

Changes:

• Internal Functions: Added detailed JSDoc comments to internal functions such as getBuildArtifact, resolvePaths, and searchFile, describing their purpose, parameters, and return values.

• Deployment Scripts: Enhanced documentation for deployment-related functions, including deployKnownFactory, deployMastercopy, and deployProxy. Each function now includes comprehensive JSDoc comments to improve clarity and maintainability.

• Test Cases: I updated the test files with JSDoc comments to describe the setup functions, individual tests, and expected outcomes. This includes documentation for tests in SignatureChecker.spec.ts, IAvatar.spec.ts, Module.spec.ts, and others.

Context:

Adding detailed documentation helps improve code readability, makes it easier for new contributors to understand the codebase, and ensures that the purpose and usage of functions are clear. This aligns with best practices for maintaining a high-quality codebase.

How Has This Been Tested?

The changes are purely documentation-based and do not alter any functionality. Existing tests have been run to ensure that the codebase remains stable.

@juliopavila juliopavila requested a review from cristovaoth August 5, 2024 15:08
@juliopavila juliopavila changed the title Feature/docs update Feat: Add comprehensive JSDoc documentation for all functions and tests and README Aug 5, 2024
@juliopavila juliopavila added the documentation Improvements or additions to documentation label Aug 5, 2024
@cristovaoth cristovaoth marked this pull request as ready for review August 7, 2024 16:16
@cristovaoth
Copy link
Collaborator

The README still lacks some detailed information about the exported Solidity contracts, but the SDK functions now have more detailed descriptions.

@juliopavila juliopavila merged commit 27385a2 into master Aug 7, 2024
0 of 2 checks passed
@github-actions github-actions bot locked and limited conversation to collaborators Aug 7, 2024
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants