Skip to content

chore(docs): Supplement descriptions for defaulting loop indices to be u64#3237

Merged
TomAFrench merged 6 commits intomasterfrom
ss/docs-default-integer
Oct 26, 2023
Merged

chore(docs): Supplement descriptions for defaulting loop indices to be u64#3237
TomAFrench merged 6 commits intomasterfrom
ss/docs-default-integer

Conversation

@Savio-Sou
Copy link
Copy Markdown
Collaborator

@Savio-Sou Savio-Sou commented Oct 20, 2023

Description

Summary*

Following #2764 and noir-lang/docs@7bb178d, this PR:

  • Removes the mentioning of Field as the default integer type from the "Fields" doc page (inaccurate)
  • Supplement exception case description of u64 being the default integer type for loops in the "Integers" doc page
  • Slightly reformatted the "Integers" doc page

PR Checklist*

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

@Savio-Sou Savio-Sou added enhancement documentation Improvements or additions to documentation labels Oct 20, 2023
@Savio-Sou Savio-Sou added this to the 0.14 milestone Oct 20, 2023
@github-actions
Copy link
Copy Markdown
Contributor

github-actions bot commented Oct 20, 2023

It's Alive!

I'm a bot, beep boop 🤖

Deployment Status: Success!

Netlify Status

Preview

🌐 View Deployment Preview

@kevaundray
Copy link
Copy Markdown
Contributor

If you do not supply a type for an integer in Noir, it would not default to u64 -- The PRs that were linked were referring to the index of a for loop

@Savio-Sou
Copy link
Copy Markdown
Collaborator Author

Oh hmm, so we now have different integer type defaults under different scenarios?

Sounds like that could get troublesome.

Copy link
Copy Markdown
Member

@TomAFrench TomAFrench left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

These docs are inaccurate as mentioned in above messages.

Savio-Sou and others added 2 commits October 26, 2023 01:05
Co-authored-by: jfecher <jake@aztecprotocol.com>
Co-authored-by: jfecher <jake@aztecprotocol.com>
@Savio-Sou Savio-Sou changed the title chore(docs): Supplement descriptions for default integers being u64 chore(docs): Supplement descriptions for defaulting loop indices to be u64 Oct 25, 2023
@Savio-Sou Savio-Sou requested a review from TomAFrench October 25, 2023 20:08
@Savio-Sou
Copy link
Copy Markdown
Collaborator Author

PR revised with Jake's suggestions incorporated.

Copy link
Copy Markdown
Contributor

@jfecher jfecher left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@TomAFrench TomAFrench added this pull request to the merge queue Oct 26, 2023
Merged via the queue into master with commit d58f15e Oct 26, 2023
@TomAFrench TomAFrench deleted the ss/docs-default-integer branch October 26, 2023 14:47
guipublic pushed a commit that referenced this pull request Oct 27, 2023
…e `u64` (#3237)

Co-authored-by: José Pedro Sousa <jose@aztecprotocol.com>
Co-authored-by: jfecher <jake@aztecprotocol.com>
guipublic pushed a commit that referenced this pull request Oct 27, 2023
…e `u64` (#3237)

Co-authored-by: José Pedro Sousa <jose@aztecprotocol.com>
Co-authored-by: jfecher <jake@aztecprotocol.com>
guipublic pushed a commit that referenced this pull request Oct 30, 2023
…e `u64` (#3237)

Co-authored-by: José Pedro Sousa <jose@aztecprotocol.com>
Co-authored-by: jfecher <jake@aztecprotocol.com>
TomAFrench added a commit that referenced this pull request Oct 30, 2023
* master: (242 commits)
  chore(docs): Update Windows installation  (#3326)
  chore!: change stdlib function `pedersen` to `pedersen_commitment` (#3341)
  chore: add back algolia recrawler (#3332)
  chore: comment out algolia recrawler workflow as its failing master (#3331)
  chore: Modify single line if-else expression width threshold (#3329)
  feat: Expand trait impl overlap check to cover generic types (#3320)
  feat: Implement where clauses on impls (#3324)
  chore: builtin wrapping shift left (#3270)
  chore: format integration tests  (#3257)
  fix(3300): cache warnings into debug artefacts (#3313)
  fix(3275): activate brillig modulo test with negative integers (#3318)
  feat: Add check for overlapping generic traits (#3307)
  feat: Refactor debugger and separate core from UI (#3308)
  chore: recrawl docs on merge (#3306)
  chore: add bn254 attribute when needed in the stdlib (#3208)
  feat: add exports of JS black box solvers to noirJS (#3295)
  chore: upload acir artifacts as a github artifact (#3288)
  chore: bump bb version to 0.12.0 (#3304)
  chore(docs): Supplement descriptions for defaulting loop indices to be `u64` (#3237)
  chore: create publish-docs.yml (#3298)
  ...
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

5 participants