docs: update Circom optimization guidance - #35
Conversation
|
No actionable comments were generated in the recent review. 🎉 ℹ️ Recent review info⚙️ Run configurationConfiguration used: defaults Review profile: CHILL Plan: Pro Run ID: 📒 Files selected for processing (1)
📝 WalkthroughWalkthroughThis pull request updates the Circom compilation documentation in the zk-email-verifier usage guide to correct outdated information about default optimization flags and clarify include directory behavior. The note now recommends ChangesCircom Compilation Documentation
Estimated code review effort🎯 1 (Trivial) | ⏱️ ~2 minutes Poem
🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches🧪 Generate unit tests (beta)
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
This updates the verifier usage guide's Circom optimization note to match the current compiler behavior:
docs/zk-email-verifier/usage-guide.md--O1is the default since Circom 2.2.0, while--O2was the pre-2.2.0 default and should be reserved for final optimization passes.--O0recommendation for easier constraint inspection while removing the incorrect claim that--O2is the default.Validation run locally:
Fixes #32.
Summary by CodeRabbit
--O0setting for beginners, version-specific defaults for Circom 2.2.0+, and refined recommendations for performance optimization.