chore: Add docs for each comptime method by jfecher · Pull Request #5802 · noir-lang/noir

jfecher · 2024-08-22T21:26:41Z

Description

Problem*

Resolves

Summary*

Adds docs for each comptime method that's been added.

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 · 2024-08-23T09:39:57Z

Changes to Brillig bytecode sizes

Generated at commit: e6fa1775b1aad04310e3b1cafa8e79876aa3632a, compared to commit: 637febf55f923b9338aa965b9d2d35e5ba99ca2b

There are no changes in circuit sizes

github-actions · 2024-08-23T10:41:26Z

🚀 Deployed on https://66c8f293d921d316ca7a7ed2--noir-docs.netlify.app

vezenovm

Mostly some nits. Going to approve as none are blocking and the docs read well.

docs/docs/noir/standard_library/meta/expr.md

docs/docs/noir/standard_library/meta/function_def.md

docs/docs/noir/standard_library/meta/module.md

docs/docs/noir/standard_library/meta/op.md

docs/docs/noir/standard_library/meta/quoted.md

docs/docs/noir/standard_library/meta/struct_def.md

docs/docs/noir/standard_library/meta/typ.md

noir_stdlib/src/meta/typ.nr

Co-authored-by: Maxim Vezenov <mvezenov@gmail.com>

…g/noir into jf/comptime-method-docs

…omptime block

…5802) chore: Add comptime docs (noir-lang/noir#5800) fix: Handle multiple entry points for Brillig call stack resolution after metadata deduplication (noir-lang/noir#5788) fix(acir_gen): Nested dynamic array initialization (noir-lang/noir#5810) fix: honor function visibility in LSP completion (noir-lang/noir#5809) feat: LSP completion now works better in the middle of idents (noir-lang/noir#5795) feat: Explicit Associated Types & Constants (noir-lang/noir#5739) feat: add `Expr::as_cast` and `UnresolvedType::is_field` (noir-lang/noir#5801) feat: add `Expr` methods: as_comptime, as_unsafe, is_break, is_continue (noir-lang/noir#5799) fix: do not use predicate for index in array operation, when the index is safe (noir-lang/noir#5779) chore: Toggle underconstrained check (noir-lang/noir#5724) feat: Add `Expr::as_block` and `Expr::has_semicolon` (noir-lang/noir#5784) feat: LSP hover and go-to-definition for crates (noir-lang/noir#5786) fix(acvm): Clear ACIR call stack after successful circuit execution (noir-lang/noir#5783) chore: sanitize url's to only allow github (noir-lang/noir#5776) chore: enable constant inputs for more blackbox (noir-lang/noir#5647) chore: move sha2 functions into the `hash` module (noir-lang/noir#5768)

chore: Add comptime docs (noir-lang/noir#5800) fix: Handle multiple entry points for Brillig call stack resolution after metadata deduplication (noir-lang/noir#5788) fix(acir_gen): Nested dynamic array initialization (noir-lang/noir#5810) fix: honor function visibility in LSP completion (noir-lang/noir#5809) feat: LSP completion now works better in the middle of idents (noir-lang/noir#5795) feat: Explicit Associated Types & Constants (noir-lang/noir#5739) feat: add `Expr::as_cast` and `UnresolvedType::is_field` (noir-lang/noir#5801) feat: add `Expr` methods: as_comptime, as_unsafe, is_break, is_continue (noir-lang/noir#5799) fix: do not use predicate for index in array operation, when the index is safe (noir-lang/noir#5779) chore: Toggle underconstrained check (noir-lang/noir#5724) feat: Add `Expr::as_block` and `Expr::has_semicolon` (noir-lang/noir#5784) feat: LSP hover and go-to-definition for crates (noir-lang/noir#5786) fix(acvm): Clear ACIR call stack after successful circuit execution (noir-lang/noir#5783) chore: sanitize url's to only allow github (noir-lang/noir#5776) chore: enable constant inputs for more blackbox (noir-lang/noir#5647) chore: move sha2 functions into the `hash` module (noir-lang/noir#5768)

…5802) chore: Add comptime docs (noir-lang/noir#5800) fix: Handle multiple entry points for Brillig call stack resolution after metadata deduplication (noir-lang/noir#5788) fix(acir_gen): Nested dynamic array initialization (noir-lang/noir#5810) fix: honor function visibility in LSP completion (noir-lang/noir#5809) feat: LSP completion now works better in the middle of idents (noir-lang/noir#5795) feat: Explicit Associated Types & Constants (noir-lang/noir#5739) feat: add `Expr::as_cast` and `UnresolvedType::is_field` (noir-lang/noir#5801) feat: add `Expr` methods: as_comptime, as_unsafe, is_break, is_continue (noir-lang/noir#5799) fix: do not use predicate for index in array operation, when the index is safe (noir-lang/noir#5779) chore: Toggle underconstrained check (noir-lang/noir#5724) feat: Add `Expr::as_block` and `Expr::has_semicolon` (noir-lang/noir#5784) feat: LSP hover and go-to-definition for crates (noir-lang/noir#5786) fix(acvm): Clear ACIR call stack after successful circuit execution (noir-lang/noir#5783) chore: sanitize url's to only allow github (noir-lang/noir#5776) chore: enable constant inputs for more blackbox (noir-lang/noir#5647) chore: move sha2 functions into the `hash` module (noir-lang/noir#5768)

chore: Add comptime docs (noir-lang/noir#5800) fix: Handle multiple entry points for Brillig call stack resolution after metadata deduplication (noir-lang/noir#5788) fix(acir_gen): Nested dynamic array initialization (noir-lang/noir#5810) fix: honor function visibility in LSP completion (noir-lang/noir#5809) feat: LSP completion now works better in the middle of idents (noir-lang/noir#5795) feat: Explicit Associated Types & Constants (noir-lang/noir#5739) feat: add `Expr::as_cast` and `UnresolvedType::is_field` (noir-lang/noir#5801) feat: add `Expr` methods: as_comptime, as_unsafe, is_break, is_continue (noir-lang/noir#5799) fix: do not use predicate for index in array operation, when the index is safe (noir-lang/noir#5779) chore: Toggle underconstrained check (noir-lang/noir#5724) feat: Add `Expr::as_block` and `Expr::has_semicolon` (noir-lang/noir#5784) feat: LSP hover and go-to-definition for crates (noir-lang/noir#5786) fix(acvm): Clear ACIR call stack after successful circuit execution (noir-lang/noir#5783) chore: sanitize url's to only allow github (noir-lang/noir#5776) chore: enable constant inputs for more blackbox (noir-lang/noir#5647) chore: move sha2 functions into the `hash` module (noir-lang/noir#5768)

…5802) chore: Add comptime docs (noir-lang/noir#5800) fix: Handle multiple entry points for Brillig call stack resolution after metadata deduplication (noir-lang/noir#5788) fix(acir_gen): Nested dynamic array initialization (noir-lang/noir#5810) fix: honor function visibility in LSP completion (noir-lang/noir#5809) feat: LSP completion now works better in the middle of idents (noir-lang/noir#5795) feat: Explicit Associated Types & Constants (noir-lang/noir#5739) feat: add `Expr::as_cast` and `UnresolvedType::is_field` (noir-lang/noir#5801) feat: add `Expr` methods: as_comptime, as_unsafe, is_break, is_continue (noir-lang/noir#5799) fix: do not use predicate for index in array operation, when the index is safe (noir-lang/noir#5779) chore: Toggle underconstrained check (noir-lang/noir#5724) feat: Add `Expr::as_block` and `Expr::has_semicolon` (noir-lang/noir#5784) feat: LSP hover and go-to-definition for crates (noir-lang/noir#5786) fix(acvm): Clear ACIR call stack after successful circuit execution (noir-lang/noir#5783) chore: sanitize url's to only allow github (noir-lang/noir#5776) chore: enable constant inputs for more blackbox (noir-lang/noir#5647) chore: move sha2 functions into the `hash` module (noir-lang/noir#5768)

chore: Add comptime docs (noir-lang/noir#5800) fix: Handle multiple entry points for Brillig call stack resolution after metadata deduplication (noir-lang/noir#5788) fix(acir_gen): Nested dynamic array initialization (noir-lang/noir#5810) fix: honor function visibility in LSP completion (noir-lang/noir#5809) feat: LSP completion now works better in the middle of idents (noir-lang/noir#5795) feat: Explicit Associated Types & Constants (noir-lang/noir#5739) feat: add `Expr::as_cast` and `UnresolvedType::is_field` (noir-lang/noir#5801) feat: add `Expr` methods: as_comptime, as_unsafe, is_break, is_continue (noir-lang/noir#5799) fix: do not use predicate for index in array operation, when the index is safe (noir-lang/noir#5779) chore: Toggle underconstrained check (noir-lang/noir#5724) feat: Add `Expr::as_block` and `Expr::has_semicolon` (noir-lang/noir#5784) feat: LSP hover and go-to-definition for crates (noir-lang/noir#5786) fix(acvm): Clear ACIR call stack after successful circuit execution (noir-lang/noir#5783) chore: sanitize url's to only allow github (noir-lang/noir#5776) chore: enable constant inputs for more blackbox (noir-lang/noir#5647) chore: move sha2 functions into the `hash` module (noir-lang/noir#5768)

feat: Improve "type annotations needed" errors (noir-lang/noir#5830) chore: enum dummy ID for `FuncId` in monomorphizer and docstring fixes (noir-lang/noir#5421) chore: delete wip fuzzing files that got accidentally added (noir-lang/noir#5829) chore: test ACVM `BigInt` (noir-lang/noir#5559) fix(docs): Fix file paths for metaprogramming docs (noir-lang/noir#5826) fix: bit shifting type checking (noir-lang/noir#5824) feat: add Expr::as_method_call (noir-lang/noir#5822) chore: Fix docs typo (noir-lang/noir#5821) feat: add `UnresolvedType::is_field` and `Expr::as_assign` (noir-lang/noir#5804) chore: Add docs for each comptime method (noir-lang/noir#5802) chore: Add comptime docs (noir-lang/noir#5800) fix: Handle multiple entry points for Brillig call stack resolution after metadata deduplication (noir-lang/noir#5788) fix(acir_gen): Nested dynamic array initialization (noir-lang/noir#5810) fix: honor function visibility in LSP completion (noir-lang/noir#5809) feat: LSP completion now works better in the middle of idents (noir-lang/noir#5795) feat: Explicit Associated Types & Constants (noir-lang/noir#5739) feat: add `Expr::as_cast` and `UnresolvedType::is_field` (noir-lang/noir#5801) feat: add `Expr` methods: as_comptime, as_unsafe, is_break, is_continue (noir-lang/noir#5799) fix: do not use predicate for index in array operation, when the index is safe (noir-lang/noir#5779) chore: Toggle underconstrained check (noir-lang/noir#5724) feat: Add `Expr::as_block` and `Expr::has_semicolon` (noir-lang/noir#5784) feat: LSP hover and go-to-definition for crates (noir-lang/noir#5786) fix(acvm): Clear ACIR call stack after successful circuit execution (noir-lang/noir#5783) chore: sanitize url's to only allow github (noir-lang/noir#5776) chore: enable constant inputs for more blackbox (noir-lang/noir#5647) chore: move sha2 functions into the `hash` module (noir-lang/noir#5768)

* master: (21 commits) chore: crypto blackbox tests (#5614) feat: Improve "type annotations needed" errors (#5830) chore: enum dummy ID for `FuncId` in monomorphizer and docstring fixes (#5421) chore: delete wip fuzzing files that got accidentally added (#5829) chore: test ACVM `BigInt` (#5559) fix(docs): Fix file paths for metaprogramming docs (#5826) fix: bit shifting type checking (#5824) feat: add Expr::as_method_call (#5822) chore: Fix docs typo (#5821) feat: add `UnresolvedType::is_field` and `Expr::as_assign` (#5804) chore: Add docs for each comptime method (#5802) chore: Add comptime docs (#5800) fix: Handle multiple entry points for Brillig call stack resolution after metadata deduplication (#5788) fix(acir_gen): Nested dynamic array initialization (#5810) fix: honor function visibility in LSP completion (#5809) feat: LSP completion now works better in the middle of idents (#5795) feat: Explicit Associated Types & Constants (#5739) feat: add `Expr::as_cast` and `UnresolvedType::is_field` (#5801) feat: add `Expr` methods: as_comptime, as_unsafe, is_break, is_continue (#5799) fix: do not use predicate for index in array operation, when the index is safe (#5779) ...

Automated pull of development from the [noir](https://github.com/noir-lang/noir) programming language, a dependency of Aztec. BEGIN_COMMIT_OVERRIDE chore: crypto blackbox tests (noir-lang/noir#5614) feat: Improve "type annotations needed" errors (noir-lang/noir#5830) chore: enum dummy ID for `FuncId` in monomorphizer and docstring fixes (noir-lang/noir#5421) chore: delete wip fuzzing files that got accidentally added (noir-lang/noir#5829) chore: test ACVM `BigInt` (noir-lang/noir#5559) fix(docs): Fix file paths for metaprogramming docs (noir-lang/noir#5826) fix: bit shifting type checking (noir-lang/noir#5824) feat: add Expr::as_method_call (noir-lang/noir#5822) chore: Fix docs typo (noir-lang/noir#5821) feat: add `UnresolvedType::is_field` and `Expr::as_assign` (noir-lang/noir#5804) chore: Add docs for each comptime method (noir-lang/noir#5802) chore: Add comptime docs (noir-lang/noir#5800) fix: Handle multiple entry points for Brillig call stack resolution after metadata deduplication (noir-lang/noir#5788) fix(acir_gen): Nested dynamic array initialization (noir-lang/noir#5810) fix: honor function visibility in LSP completion (noir-lang/noir#5809) feat: LSP completion now works better in the middle of idents (noir-lang/noir#5795) feat: Explicit Associated Types & Constants (noir-lang/noir#5739) feat: add `Expr::as_cast` and `UnresolvedType::is_field` (noir-lang/noir#5801) feat: add `Expr` methods: as_comptime, as_unsafe, is_break, is_continue (noir-lang/noir#5799) fix: do not use predicate for index in array operation, when the index is safe (noir-lang/noir#5779) chore: Toggle underconstrained check (noir-lang/noir#5724) feat: Add `Expr::as_block` and `Expr::has_semicolon` (noir-lang/noir#5784) feat: LSP hover and go-to-definition for crates (noir-lang/noir#5786) fix(acvm): Clear ACIR call stack after successful circuit execution (noir-lang/noir#5783) chore: sanitize url's to only allow github (noir-lang/noir#5776) chore: enable constant inputs for more blackbox (noir-lang/noir#5647) chore: move sha2 functions into the `hash` module (noir-lang/noir#5768) END_COMMIT_OVERRIDE --------- Co-authored-by: sirasistant <sirasistant@gmail.com> Co-authored-by: Maxim Vezenov <mvezenov@gmail.com>

* master: (35 commits) fix!: Check unused generics are bound (#5840) chore(perf): Simplify poseidon2 algorithm (#5811) chore: redo typo PR by nnsW3 (#5834) fix(sha256): Perform compression per block and utilize ROM instead of RAM when setting up the message block (#5760) chore(perf): Update to stdlib keccak for reduced Brillig code size (#5827) chore: crypto blackbox tests (#5614) feat: Improve "type annotations needed" errors (#5830) chore: enum dummy ID for `FuncId` in monomorphizer and docstring fixes (#5421) chore: delete wip fuzzing files that got accidentally added (#5829) chore: test ACVM `BigInt` (#5559) fix(docs): Fix file paths for metaprogramming docs (#5826) fix: bit shifting type checking (#5824) feat: add Expr::as_method_call (#5822) chore: Fix docs typo (#5821) feat: add `UnresolvedType::is_field` and `Expr::as_assign` (#5804) chore: Add docs for each comptime method (#5802) chore: Add comptime docs (#5800) fix: Handle multiple entry points for Brillig call stack resolution after metadata deduplication (#5788) fix(acir_gen): Nested dynamic array initialization (#5810) fix: honor function visibility in LSP completion (#5809) ...

* master: (29 commits) fix!: Check unused generics are bound (#5840) chore(perf): Simplify poseidon2 algorithm (#5811) chore: redo typo PR by nnsW3 (#5834) fix(sha256): Perform compression per block and utilize ROM instead of RAM when setting up the message block (#5760) chore(perf): Update to stdlib keccak for reduced Brillig code size (#5827) chore: crypto blackbox tests (#5614) feat: Improve "type annotations needed" errors (#5830) chore: enum dummy ID for `FuncId` in monomorphizer and docstring fixes (#5421) chore: delete wip fuzzing files that got accidentally added (#5829) chore: test ACVM `BigInt` (#5559) fix(docs): Fix file paths for metaprogramming docs (#5826) fix: bit shifting type checking (#5824) feat: add Expr::as_method_call (#5822) chore: Fix docs typo (#5821) feat: add `UnresolvedType::is_field` and `Expr::as_assign` (#5804) chore: Add docs for each comptime method (#5802) chore: Add comptime docs (#5800) fix: Handle multiple entry points for Brillig call stack resolution after metadata deduplication (#5788) fix(acir_gen): Nested dynamic array initialization (#5810) fix: honor function visibility in LSP completion (#5809) ...

Add docs for each comptime method

93b2ad9

jfecher requested a review from a team August 22, 2024 21:26

github-actions bot added the documentation Improvements or additions to documentation label Aug 22, 2024

jfecher and others added 3 commits August 22, 2024 16:28

Typo

8a4f589

cspell

20bcf22

fix: update references to is_greater_or_equal

817a1fc

TomAFrench added 2 commits August 23, 2024 09:59

chore: as_unary -> as_unary_op

adef15b

chore: add snippet tags

8514e63

jfecher added 7 commits August 23, 2024 10:21

Rename more

e8080c3

Nargo fmt; hopefully //doc:start still works while indented

e99bb7e

Add index page

a568cc1

Specify the full module path on each page

41d6498

Merge branch 'master' into jf/comptime-method-docs

52b8d66

Move mod.md to index.md

7f97422

Format

efb3ad1

jfecher enabled auto-merge August 23, 2024 20:43

vezenovm approved these changes Aug 23, 2024

View reviewed changes

jfecher and others added 10 commits August 23, 2024 15:52

Update docs/docs/noir/standard_library/meta/function_def.md

a2e12e3

Co-authored-by: Maxim Vezenov <mvezenov@gmail.com>

Update docs/docs/noir/standard_library/meta/module.md

0921d74

Co-authored-by: Maxim Vezenov <mvezenov@gmail.com>

Update docs/docs/noir/standard_library/meta/op.md

a3ddc79

Co-authored-by: Maxim Vezenov <mvezenov@gmail.com>

Update docs/docs/noir/standard_library/meta/module.md

cceeeea

Co-authored-by: Maxim Vezenov <mvezenov@gmail.com>

Update docs/docs/noir/standard_library/meta/quoted.md

b650024

Co-authored-by: Maxim Vezenov <mvezenov@gmail.com>

Update docs/docs/noir/standard_library/meta/struct_def.md

d61e45c

Co-authored-by: Maxim Vezenov <mvezenov@gmail.com>

Add snippets

38ee314

Merge branch 'jf/comptime-method-docs' of https://github.com/noir-lan…

3342a43

…g/noir into jf/comptime-method-docs

nargo fmt removes 'comptime' keyword if there is a comment before a c…

6822c85

…omptime block

Format

4159827

jfecher added this pull request to the merge queue Aug 23, 2024

Merged via the queue into master with commit de0f8ee Aug 23, 2024

jfecher deleted the jf/comptime-method-docs branch August 23, 2024 21:49

AztecBot mentioned this pull request Aug 24, 2024

feat: Sync from noir AztecProtocol/aztec-packages#8125

Merged

AztecBot mentioned this pull request Aug 27, 2024

chore(master): Release 0.51.0 AztecProtocol/aztec-packages#8158

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

chore: Add docs for each comptime method#5802

chore: Add docs for each comptime method#5802
jfecher merged 23 commits intomasterfrom
jf/comptime-method-docs

jfecher commented Aug 22, 2024

Uh oh!

github-actions bot commented Aug 23, 2024 •

edited

Loading

Uh oh!

github-actions bot commented Aug 23, 2024 •

edited

Loading

Uh oh!

vezenovm left a comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

Conversation

jfecher commented Aug 22, 2024

Description

Problem*

Summary*

Additional Context

Documentation*

PR Checklist*

Uh oh!

github-actions bot commented Aug 23, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Changes to Brillig bytecode sizes

There are no changes in circuit sizes

Uh oh!

github-actions bot commented Aug 23, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

vezenovm left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

github-actions bot commented Aug 23, 2024 •

edited

Loading

github-actions bot commented Aug 23, 2024 •

edited

Loading