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

Add jsdoc comments for all module builder and ignition helper functions #674

Merged
merged 5 commits into from
Jan 16, 2024
Merged

Add jsdoc comments for all module builder and ignition helper functions #674

merged 5 commits into from
Jan 16, 2024

Conversation

zoeyTM
Copy link
Contributor

@zoeyTM zoeyTM commented Jan 15, 2024

resolves #642

kanej
kanej requested changes Jan 15, 2024
View reviewed changes
Copy link
Member

@kanej kanej left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is looking good.
I suspect we will be iterating on these docs forever, but I left a few suggestions.

@kanej kanej force-pushed the module-builder-jsdoc branch from ac740cc to f3a60f7 Compare January 16, 2024 10:10
kanej
kanej approved these changes Jan 16, 2024
View reviewed changes
Copy link
Member

@kanej kanej left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM!

@kanej kanej merged commit 17be07d into development Jan 16, 2024
6 checks passed
@kanej kanej deleted the module-builder-jsdoc branch January 16, 2024 10:27
kanej pushed a commit that referenced this pull request Jan 25, 2024
@zoeyTM @kanej
Add jsdoc comments for all module builder and ignition helper functio…
44ed175 
…ns (#674)

Add doc comments to the public module API to provide better intellisense to users writing modules.

Resolves #642
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@kanej kanej kanej approved these changes

Assignees
No one assigned
Labels
status:triaging
Projects
Hardhat Ignition
Status: Done
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

Ensure all module api and ignition helper classes are documented
2 participants
@zoeyTM @kanej