Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

chore(docs): address visibility issues in docs #3643

Merged
merged 2 commits into from
Nov 30, 2023
Merged

chore(docs): address visibility issues in docs #3643

merged 2 commits into from
Nov 30, 2023

Conversation

TomAFrench
Copy link
Member

@TomAFrench TomAFrench commented Nov 30, 2023 •
edited
Loading

Description

Problem*

Resolves #3452

Summary*

This PR makes two changes in the docs:

  1. I've removed the visibility modifier on an argument to the non-entrypoint function foo. This code would compile but would also raise a warning on pub being unnecessary and misleading so we should just remove it.
  2. pub was missing on a main function return value in 7_mutability.md.

Additional Context

Documentation*

Check one:

  • No documentation needed.
  • Documentation included in this PR.
  • [Exceptional Case] 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 github-actions bot added the documentation Improvements or additions to documentation label Nov 30, 2023
@TomAFrench TomAFrench mentioned this pull request Nov 30, 2023
Closed
@github-actions GitHub Actions
Copy link
Contributor

🚀 Deployed on https://65689046d2888304844d4f93--noir-docs.netlify.app

@signorecello signorecello added this pull request to the merge queue Nov 30, 2023
Merged via the queue into master with commit 6e3aea5 Nov 30, 2023
34 checks passed
@signorecello signorecello deleted the tf/docs-visibility branch November 30, 2023 14:20
TomAFrench added a commit that referenced this pull request Nov 30, 2023
@TomAFrench
Merge branch 'master' into kw/change-to-lowercase-field
b6330d0 
* master:
  chore(docs): address visibility issues in docs (#3643)
  chore: type formatting (#3618)
  fix: Restrict fill_internal_slices pass to acir functions (#3634)
  chore(docs): docs for v0.19.4 (#3601)
  feat: aztec-packages (#3626)
  chore: Move tests to the correct root (#3633)
  feat: Implement integer printing (#3577)
  fix: corrected the formatting of error message parameters in index out of bounds error (#3630)
  chore: Update ACIR artifacts (#3619)
  chore(debugger): Run debugger REPL in thread (#3611)
  chore: remove deprecated method (#3625)
TomAFrench added a commit that referenced this pull request Nov 30, 2023
@TomAFrench
Merge branch 'master' into tf/recursive-onchain
987cf9d 
* master: (216 commits)
  chore(docs): address visibility issues in docs (#3643)
  chore: type formatting (#3618)
  fix: Restrict fill_internal_slices pass to acir functions (#3634)
  chore(docs): docs for v0.19.4 (#3601)
  feat: aztec-packages (#3626)
  chore: Move tests to the correct root (#3633)
  feat: Implement integer printing (#3577)
  fix: corrected the formatting of error message parameters in index out of bounds error (#3630)
  chore: Update ACIR artifacts (#3619)
  chore(debugger): Run debugger REPL in thread (#3611)
  chore: remove deprecated method (#3625)
  feat: Implement raw string literals (#3556)
  fix: docker builds (#3620)
  feat: Copy on write optimization for brillig (#3522)
  chore: separate methods in `dc_crate` into their own modules (#3585)
  feat: add special case for boolean AND in acir-gen (#3615)
  chore: Update ACIR artifacts (#3614)
  chore: remove `get_number_sequence` foreign calls (#3613)
  feat: Add package version to Nargo.toml metadata (#3427)
  chore(docs): Links to Aztec docs from errors (#3423)
  ...
TomAFrench added a commit that referenced this pull request Dec 1, 2023
@TomAFrench
Merge branch 'master' into tf/track-bb-witness-equivalence
8d7be6f 
* master: (124 commits)
  chore: add env var for test updates in nargo_fmt (#3638)
  chore: remove unnecessary conversions from `add_constant` (#3651)
  feat: Complex slice inputs for dynamic slice builtins (#3617)
  feat: Add `FieldElement::from<usize>` implementation (#3647)
  chore: fix relative paths in reease please (#3646)
  chore: add integration test for verifying a recursive proof onchain (#3167)
  chore: adding docs to release please (#3571)
  chore(ci): Fix publishing of ACVM crates (#3645)
  chore(docs): address visibility issues in docs (#3643)
  chore: type formatting (#3618)
  fix: Restrict fill_internal_slices pass to acir functions (#3634)
  chore(docs): docs for v0.19.4 (#3601)
  feat: aztec-packages (#3626)
  chore: Move tests to the correct root (#3633)
  feat: Implement integer printing (#3577)
  fix: corrected the formatting of error message parameters in index out of bounds error (#3630)
  chore: Update ACIR artifacts (#3619)
  chore(debugger): Run debugger REPL in thread (#3611)
  chore: remove deprecated method (#3625)
  feat: Implement raw string literals (#3556)
  ...
TomAFrench added a commit that referenced this pull request Dec 1, 2023
@TomAFrench
Merge branch 'master' into gd/databus
840fde8 
* master: (28 commits)
  feat: reuse witnesses more when interacting with memory (#3658)
  chore(ci): stop committing new acir artifacts (#3654)
  chore: add env var for test updates in nargo_fmt (#3638)
  chore: remove unnecessary conversions from `add_constant` (#3651)
  feat: Complex slice inputs for dynamic slice builtins (#3617)
  feat: Add `FieldElement::from<usize>` implementation (#3647)
  chore: fix relative paths in reease please (#3646)
  chore: add integration test for verifying a recursive proof onchain (#3167)
  chore: adding docs to release please (#3571)
  chore(ci): Fix publishing of ACVM crates (#3645)
  chore(docs): address visibility issues in docs (#3643)
  chore: type formatting (#3618)
  fix: Restrict fill_internal_slices pass to acir functions (#3634)
  chore(docs): docs for v0.19.4 (#3601)
  feat: aztec-packages (#3626)
  chore: Move tests to the correct root (#3633)
  feat: Implement integer printing (#3577)
  fix: corrected the formatting of error message parameters in index out of bounds error (#3630)
  chore: Update ACIR artifacts (#3619)
  chore(debugger): Run debugger REPL in thread (#3611)
  ...
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@signorecello signorecello signorecello approved these changes

Assignees
No one assigned
Labels
documentation Improvements or additions to documentation
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

Example code is missing pub keywords in returns
2 participants
@TomAFrench @signorecello