Document the #[recursive] attribute on the Recursive Proofs doc page
#4392
Assignees
Labels
documentation
Improvements or additions to documentation
recursion
Recursive proving / proof aggregation
Milestone
Comments
Savio-Sou
added
enhancement
5 tasks
github-merge-queue bot
pushed a commit
that referenced
this issue
Feb 22, 2024
# Description ## Problem Step towards [#4392](#4392) The documentation for Recursive Proofs was lacking information on the newly introduced `#[recursive]` attribute, which is crucial for understanding how to mark circuits for recursive proof generation. ## Summary This pull request updates the Recursive Proofs documentation page to include a comprehensive section on the `#[recursive]` attribute. It explains the attribute's purpose, how it should be used, and provides an example demonstrating its application within a circuit definition. ## Additional Context The introduction of the `#[recursive]` attribute simplifies the process of designating circuits for recursive proofs, eliminating the need for manual flagging in the tooling infrastructure. ## Documentation - [ ] No documentation needed. - [x] Documentation included in this PR. - [ ] **[Exceptional Case]** Documentation to be submitted in a separate PR. # PR Checklist - [x] I have tested the changes locally. - [x] I have formatted the changes with [Prettier](https://prettier.io/) and/or `cargo fmt` on default settings. --------- Co-authored-by: Savio <72797635+Savio-Sou@users.noreply.github.com>
Savio-Sou
added
recursion
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Problem
The Recursive Proofs doc page was updated, but without mentioning of the new
#[recursive]attribute: #4187 (comment)Happy Case
Supplement how is the attribute used in the "Example usage" section.
As v0.24.0 is pre-released, reminder to copy doc changes into version-v0.24.0 when making them.
Project Impact
Blocker
Impact Context
Prerequisite to v0.24.0's public release aimed in the week of 26 Feb.
Workaround
None
Workaround Description
No response
Additional Context
Not a must but I would personally recommend tackling noir-lang/noir-examples#16 first to ensure we have a working example before documenting it.
Would you like to submit a PR for this Issue?
None
Support Needs
No response
The text was updated successfully, but these errors were encountered: