-
Notifications
You must be signed in to change notification settings - Fork 0
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
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
juliopavila
changed the title
Feature/docs update
Feat: Add comprehensive JSDoc documentation for all functions and tests and README
Aug 5, 2024
cristovaoth
reviewed
Aug 6, 2024
cristovaoth
reviewed
Aug 6, 2024
cristovaoth
reviewed
Aug 6, 2024
cristovaoth
reviewed
Aug 6, 2024
cristovaoth
reviewed
Aug 6, 2024
cristovaoth
reviewed
Aug 6, 2024
cristovaoth
reviewed
Aug 6, 2024
cristovaoth
reviewed
Aug 6, 2024
The README still lacks some detailed information about the exported Solidity contracts, but the SDK functions now have more detailed descriptions. |
samepant
approved these changes
Aug 7, 2024
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
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.