chore(ssa refactor): Add all remaining doc comments to ssa generation pass by jfecher · Pull Request #1256 · noir-lang/noir

jfecher · 2023-04-28T21:50:06Z

Related issue(s)

Resolves #

Description

Summary of changes

Adds a doc comment for every function that was missing one in the ssa generation pass.

There are also some minor code edits:

Renaming pred_iter and succ_iter to predecessors and successors
Removing some unused fields
Using std::mem::take in one spot

Dependency additions / changes

Test additions / changes

Checklist

I have tested the changes locally.
I have formatted the changes with Prettier and/or cargo fmt with default settings.
I have linked this PR to the issue(s) that it resolves.
I have reviewed the changes on GitHub, line by line.
I have ensured all changes are covered in the description.

Documentation needs

This PR requires documentation updates when merged.

Additional context

kevaundray

Looks good overall -- left some comments and questions

Co-authored-by: kevaundray <kevtheappdev@gmail.com>

…nto jf/ssa-comments

kevaundray · 2023-05-01T14:49:06Z

Looks good --going to hold this off until #1226 is merged (about 10 minutes)

… pass (#1256) * Add remaining doc comments * Update crates/noirc_evaluator/src/ssa_refactor/ir/cfg.rs Co-authored-by: kevaundray <kevtheappdev@gmail.com> * Update crates/noirc_evaluator/src/ssa_refactor/ir/cfg.rs Co-authored-by: kevaundray <kevtheappdev@gmail.com> * Address PR feedback --------- Co-authored-by: kevaundray <kevtheappdev@gmail.com>

* master: (63 commits) feat(nargo): Remove usage of `CompiledProgram` in CLI code and use separate ABI/bytecode (#1269) feat: add integration tests for bitshift operators (#1272) chore: Replace explicit if-elses with `FieldElement::from<bool>()` for boolean fields (#1266) chore(noir): constrain expr; -> assert(expr); (#1276) chore: fix clippy warning (#1270) chore(ssa refactor): Add all remaining doc comments to ssa generation pass (#1256) chore(noir): Release 0.5.1 (#1264) fix: Add Poseidon examples into integration tests (#1257) chore(nargo): replace `aztec_backend` with `acvm-backend-barretenberg` (#1226) chore(noir): Release 0.5.0 (#1202) chore(ci): Utilize new workflow to build binaries (#1250) chore(ssa refactor): Fix loading from mutable parameters (#1248) fix(wasm): add std after dependencies (#1245) chore(ssa refactor): Fix no returns & duplicate main (#1243) chore(ssa refactor): Implement intrinsics (#1241) chore(ssa refactor): Implement first-class functions (#1238) chore: address clippy warnings (#1239) chore(ssa refactor): Implement function calls (#1235) chore(ssa refactor): Implement mutable and immutable variables (#1234) chore(ssa refactor): Fix recursive printing of blocks (#1230) ...

Add remaining doc comments

ec981c8