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

Ensure all module api and ignition helper classes are documented #642

Closed
2 tasks done
kanej opened this issue Dec 8, 2023 · 0 comments · Fixed by #674
Closed
2 tasks done

Ensure all module api and ignition helper classes are documented #642

kanej opened this issue Dec 8, 2023 · 0 comments · Fixed by #674
Assignees
@zoeyTM
Labels
status:ready This issue is ready to be worked on type:docs Documentation-related issue

Comments

@kanej
Copy link
Member

kanej commented Dec 8, 2023 •
edited by zoeyTM
Loading

To better support intellisense discovery of how to leverage different parts of the api we should document with appropriate comments all the methods/functions in our api.

TODO

  • Each method on the ModuleBuilder object injected as part of buildModule should be documented
  • Do a run through of locally developing some contracts and then iterate on the docs to best support new users to Ignition
@kanej kanej moved this to Todo in Hardhat Ignition Dec 8, 2023
@kanej kanej added type:docs Documentation-related issue status:ready This issue is ready to be worked on and removed status:triaging labels Dec 11, 2023
@zoeyTM zoeyTM moved this from Todo to In Progress in Hardhat Ignition Jan 8, 2024
@zoeyTM zoeyTM mentioned this issue Jan 15, 2024
Merged
@zoeyTM zoeyTM moved this from In Progress to In Review in Hardhat Ignition Jan 15, 2024
kanej pushed a commit that referenced this issue Jan 16, 2024
@zoeyTM
Add jsdoc comments for all module builder and ignition helper functio…
17be07d 
…ns (#674)

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

Resolves #642
@github-project-automation github-project-automation bot moved this from In Review to Done in Hardhat Ignition Jan 16, 2024
@kanej kanej mentioned this issue Jan 25, 2024
Merged
kanej pushed a commit that referenced this issue 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
Assignees

@zoeyTM zoeyTM

Labels
status:ready This issue is ready to be worked on type:docs Documentation-related issue
Projects
Hardhat Ignition
Archived in project
Milestone
No milestone
2 participants
@kanej @zoeyTM