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

docs: describe that hint inputs and outputs are init-ed #1003

Merged
merged 1 commit into from
Jan 22, 2024

Conversation

ivokub
Copy link
Collaborator

@ivokub ivokub commented Jan 15, 2024

Description

It is not mentioned that inputs and outputs are already initialized and the user shouldn't leak the value. Clarified a bit.

Related: #998

Type of change

  • Bug fix (non-breaking change which fixes an issue)
  • This change requires a documentation update

How has this been tested?

Not tested

How has this been benchmarked?

Not benchmarked.

Checklist:

  • I have performed a self-review of my code
  • I have commented my code, particularly in hard-to-understand areas
  • I have made corresponding changes to the documentation
  • I have added tests that prove my fix is effective or that my feature works
  • I did not modify files generated from templates
  • golangci-lint does not output errors locally
  • New and existing unit tests pass locally with my changes
  • Any dependent changes have been merged and published in downstream modules

@ivokub ivokub added the doc label Jan 15, 2024
@ivokub ivokub requested a review from gbotrel January 15, 2024 13:43
@ivokub ivokub self-assigned this Jan 15, 2024
@gbotrel gbotrel merged commit aa1dc4e into master Jan 22, 2024
7 checks passed
@gbotrel gbotrel deleted the docs/hint-api branch January 22, 2024 19:20
ahmetyalp pushed a commit to ahmetyalp/gnark that referenced this pull request Jan 23, 2024
ahmetyalp pushed a commit to ahmetyalp/gnark that referenced this pull request Jan 23, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants