chore: document intrinsics #9382

guipublic · 2025-08-04T14:04:29Z

Description

Problem*

Resolves #8138

Summary*

doc comments for intrinsics

Additional Context

Documentation*

Check one:

No documentation needed.
Documentation included in this PR.
[For Experimental Features] Documentation to be submitted in a separate PR.

PR Checklist*

I have tested the changes locally.
I have formatted the changes with Prettier and/or cargo fmt on default settings.

github-actions

⚠️ Performance Alert ⚠️

Possible performance regression was detected for benchmark 'Compilation Time'.
Benchmark result of this commit is worse than the previous benchmark result exceeding threshold 1.20.

Benchmark suite	Current: `c887e68`	Previous: `8146755`	Ratio
`rollup-root`	`1.744` s	`1.43` s	`1.22`

This comment was automatically generated by workflow using github-action-benchmark.

CC: @TomAFrench

github-actions

⚠️ Performance Alert ⚠️

Possible performance regression was detected for benchmark 'Test Suite Duration'.
Benchmark result of this commit is worse than the previous benchmark result exceeding threshold 1.20.

Benchmark suite	Current: `fd6ddde`	Previous: `a24cfcc`	Ratio
`test_report_zkpassport_noir_rsa_`	`2` s	`1` s	`2`

This comment was automatically generated by workflow using github-action-benchmark.

CC: @TomAFrench

compiler/noirc_evaluator/src/ssa/ir/instruction.rs

asterite

Looks good! I missed a few misspellings, I don't know why I didn't see them before.

guipublic · 2025-08-08T16:53:03Z

Looks good! I missed a few misspellings, I don't know why I didn't see them before.

Thank you and sorry for the trouble, I lost spellcheck when I switched from mainframe (too instable lately) to local. Do you know about a vscode plugin I can use?

asterite · 2025-08-08T17:11:53Z

Thank you and sorry for the trouble, I lost spellcheck when I switched from mainframe (too instable lately) to local. Do you know about a vscode plugin I can use?

All good! I have one installed, can't remember why, it's called "Code Spell Checker"... but I always forget to check it. The problem is that it gives errors on the files you have open so if you make edits to a file and close it you might not see it. I end up just reviewing the spelling errors in GitHub (previously I didn't care that much to be honest but some weeks ago I sent a PR to fix all the spell issues in our Rust code so I'm trying to keep it to zero now whenever I can 😅).

Automated pull of nightly from the [noir](https://github.com/noir-lang/noir) programming language, a dependency of Aztec. BEGIN_COMMIT_OVERRIDE fix: don't thread-bomb unnecessarily (noir-lang/noir#9643) chore(mem2reg): Only add to per function last_loads if load is not removed (noir-lang/noir#9647) chore(mem2reg): add a few regression tests (noir-lang/noir#9615) fix: Monomorphize function values as pairs of `(constrained, unconstrained)` (noir-lang/noir#9484) fix(mem2reg): Mark block parameters with unknown alias sets in presence of nested references (noir-lang/noir#9629) fix(ssa): Put some default in `Value::uninitialized` for references in the SSA interpreter (noir-lang/noir#9603) feat(ssa_fuzzer): ecdsa blackbox functions (noir-lang/noir#9584) fix(mem2reg): missing alias from block parameter to its argument (noir-lang/noir#9640) fix(acir_gen): A slice might be a nested Array, not a flattened DynamicArray (noir-lang/noir#9600) chore: add another mem2reg regression for #9613 (noir-lang/noir#9635) chore: document remove_if_else (in preparation for audit) (noir-lang/noir#9621) fix(mem2reg): Assume all function reference parameters have an unknown alias set with nested references (noir-lang/noir#9632) chore: add a regression test for #9613 (noir-lang/noir#9630) fix: Revert "feat(mem2reg): address last known value is independent of its… (noir-lang/noir#9628) fix(inlining): Do not inline globals and lower them during ACIR gen (noir-lang/noir#9626) chore(brillig): Include function name with `--count-array-copies` debug information (noir-lang/noir#9623) chore: use `assert_ssa_does_not_change` throughout all SSA tests (noir-lang/noir#9625) chore: only run remove_paired_rc in brillig functions (noir-lang/noir#9624) chore: some inlining refactors (noir-lang/noir#9622) chore(mem2reg): avoid redundant PostOrder computation (noir-lang/noir#9620) chore: bump external pinned commits (noir-lang/noir#9618) chore: document intrinsics (noir-lang/noir#9382) fix: Make inc/dec_rc impure (noir-lang/noir#9617) chore: greenlight `checked_to_unchecked` for audits (noir-lang/noir#9537) feat(mem2reg): address last known value is independent of its aliases (noir-lang/noir#9613) fix: Fix if-else alias in mem2reg (noir-lang/noir#9611) END_COMMIT_OVERRIDE

document intrinsics

c887e68

github-actions bot reviewed Aug 4, 2025

View reviewed changes

fix doc

610e613

guipublic requested a review from a team August 4, 2025 17:07

Merge branch 'master' into gd/issue_8138

ff4cb9a

github-actions bot reviewed Aug 4, 2025

View reviewed changes