chore: Document BoundedVec #4430
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
github-actions
bot
added
the
documentation
5 tasks
|
This PR requires #4431 for the changed |
|
Looks like this is failing due to some formatting differences in files in the stdlib that I did not touch. I'll update the PR to include them |
|
🚀 Deployed on https://65de665efa8df45130da3c3c--noir-docs.netlify.app |
|
Can you update the examples to pull code from snippets? We can then be sure that the code in the docs is tested. |
github-merge-queue bot
pushed a commit
that referenced
this pull request
Feb 27, 2024
# Description ## Problem\* ## Summary\* Removes the `empty_value` field from the bounded vec. This muddies the API and shouldn't be needed since we have `crate::unsafe::zeroed()` instead. ## Additional Context ## Documentation\* Check one: - [ ] No documentation needed. - [ ] Documentation included in this PR. - [x] **[Exceptional Case]** Documentation to be submitted in a separate PR. - Included in #4430 # 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: Tom French <[email protected]> Co-authored-by: Tom French <[email protected]>
|
Looks like re-running the tests twice fixed the issue. Third time's the charm. |
|
FYI @noir-lang/developerrelations on Noir doc changes. |
TomAFrench
approved these changes
Feb 28, 2024
TomAFrench
added a commit
that referenced
this pull request
Mar 2, 2024
* master: (27 commits) feat: skip redundant range checks in brillig (#4460) fix: Variables from trait constraints being permanently bound over when used within a trait impl (#4450) feat: Add overflow and underflow checks for unsigned integers in brillig (#4445) fix(flake): stop flake.nix removing ignored-tests.txt (#4455) fix: build noir_codegen when publishing (#4448) chore: only ignore Nargo.toml in `test_programs` directory and not su… (#4451) chore: create parser specifically for function visibility (#4425) chore: Document BoundedVec (#4430) chore: split up parser into separate files for code organisation (#4420) feat: Sync from aztec-packages (#4444) chore!: reserve `unchecked` keyword (#4432) chore: address code review comments of PR4398 (#4435) feat: Sync from aztec-packages (#4439) feat: Sync from aztec-packages (#4438) chore(docs): correct 'Edit this page' URL for dev docs (#4433) feat: Sync from aztec-packages (#4390) chore(docs): fix external contributor force push workflow (#4437) chore!: Remove empty value from bounded vec (#4431) chore: nargo fmt (#4434) feat: add poseidon2 opcode implementation for acvm/brillig, and Noir (#4398) ...
TomAFrench
added a commit
that referenced
this pull request
Mar 4, 2024
* master: chore: export `report_errors` from `nargo` (#4461) feat: add option to set max memory for bb.js (#4227) feat: backpropagate constants in ACIR during optimization (#3926) feat: skip redundant range checks in brillig (#4460) fix: Variables from trait constraints being permanently bound over when used within a trait impl (#4450) feat: Add overflow and underflow checks for unsigned integers in brillig (#4445) fix(flake): stop flake.nix removing ignored-tests.txt (#4455) fix: build noir_codegen when publishing (#4448) chore: only ignore Nargo.toml in `test_programs` directory and not su… (#4451) chore: create parser specifically for function visibility (#4425) chore: Document BoundedVec (#4430) chore: split up parser into separate files for code organisation (#4420) feat: Sync from aztec-packages (#4444) chore!: reserve `unchecked` keyword (#4432) chore: address code review comments of PR4398 (#4435) feat: Sync from aztec-packages (#4439) feat: Sync from aztec-packages (#4438)
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
Problem*
Resolves #4348
Summary*
Documents
BoundedVecAdditional Context
Documentation*
Check one:
PR Checklist*
cargo fmton default settings.