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

Document exposed functions #14

Closed
1 task
Tracked by #46
TomAFrench opened this issue May 22, 2023 · 0 comments · Fixed by #60
Closed
1 task
Tracked by #46

Document exposed functions #14

TomAFrench opened this issue May 22, 2023 · 0 comments · Fixed by #60
Assignees
Labels
enhancement New feature or request good first issue Good for newcomers
Milestone

Comments

@TomAFrench
Copy link
Member

Problem

ACVM simulator is a user facing package so we need to ensure that it's easy to use for developers which are new to the Noir JS ecosystem.

Proposed solution

Each function should be properly documented with information on how it should be used.

As an example see #13

Alternatives considered

No response

Additional context

This work should ideally be done in conjunction with #enforce

Submission Checklist

  • Once I hit submit, I will assign this issue to the Project Board with the appropriate tags.
@TomAFrench TomAFrench added enhancement New feature or request good first issue Good for newcomers labels May 22, 2023
@github-project-automation github-project-automation bot moved this to 📋 Backlog in Noir May 22, 2023
@TomAFrench TomAFrench added this to the v0.1.0 milestone Jun 20, 2023
@github-project-automation github-project-automation bot moved this from 📋 Backlog to ✅ Done in Noir Jun 20, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request good first issue Good for newcomers
Projects
Archived in project
Development

Successfully merging a pull request may close this issue.

1 participant