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): Document signed integers and integer overflow behavior #3393

Merged
merged 19 commits into from
Nov 2, 2023
Merged

chore(docs): Document signed integers and integer overflow behavior #3393

merged 19 commits into from
Nov 2, 2023

Conversation

Savio-Sou
Copy link
Collaborator

@Savio-Sou Savio-Sou commented Nov 1, 2023 •
edited
Loading

Description

Problem*

Document #2748 and #2713 respectively.

Summary*

  • Document signed integers
  • Document overflow behaviors of both unsigned and signed integers
  • Update existing unsigned integer description and examples

Additional Context

Drafting this so that we could get v0.19.0 out sooner before Devconnect.

@guipublic would appreciate for your quick review.

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.

@Savio-Sou Savio-Sou added the documentation Improvements or additions to documentation label Nov 1, 2023
@github-actions GitHub Actions
Copy link
Contributor

github-actions bot commented Nov 1, 2023 •
edited
Loading

🚀 Deployed on https://6543da1cc2c96e23cfc27e40--noir-docs.netlify.app

This was referenced Nov 1, 2023
Closed
Closed
@signorecello
Copy link
Contributor

It just needs to have wrapping_add documented as well if one wants to go around this. lmk if you want me to document it @Savio-Sou and thanks for the help with this!

@signorecello
Copy link
Contributor

documenting wrapping_add now...

@Savio-Sou Savio-Sou mentioned this pull request Nov 2, 2023
Merged
jfecher
jfecher reviewed Nov 2, 2023
View reviewed changes
Copy link
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.

Some grammar suggestions.

Seems like there's also an annoying GitHub change (bug?) where it is much more difficult to comment on a range of lines now.

docs/docs/language_concepts/data_types/01_integers.md Outdated Show resolved Hide resolved
docs/docs/language_concepts/data_types/01_integers.md Outdated Show resolved Hide resolved
docs/docs/language_concepts/data_types/01_integers.md Outdated Show resolved Hide resolved
docs/docs/language_concepts/data_types/01_integers.md Outdated Show resolved Hide resolved
docs/docs/language_concepts/data_types/01_integers.md Outdated Show resolved Hide resolved
docs/docs/language_concepts/data_types/01_integers.md Outdated Show resolved Hide resolved
docs/docs/language_concepts/data_types/01_integers.md Outdated Show resolved Hide resolved
docs/docs/language_concepts/data_types/01_integers.md Outdated Show resolved Hide resolved
docs/docs/language_concepts/data_types/01_integers.md Outdated Show resolved Hide resolved
docs/docs/language_concepts/data_types/01_integers.md Outdated Show resolved Hide resolved
jfecher
jfecher reviewed Nov 2, 2023
View reviewed changes
Copy link
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.

Some more code formatting

docs/docs/language_concepts/data_types/01_integers.md Outdated Show resolved Hide resolved
docs/docs/language_concepts/data_types/01_integers.md Outdated Show resolved Hide resolved
docs/docs/language_concepts/data_types/01_integers.md Outdated Show resolved Hide resolved
jfecher
jfecher approved these changes Nov 2, 2023
View reviewed changes
Copy link
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

@Savio-Sou Savio-Sou enabled auto-merge November 2, 2023 17:15
@Savio-Sou Savio-Sou added this pull request to the merge queue Nov 2, 2023
@github-merge-queue github-merge-queue bot removed this pull request from the merge queue due to no response for status checks Nov 2, 2023
@Savio-Sou Savio-Sou added this pull request to the merge queue Nov 2, 2023
Merged via the queue into master with commit 5c69191 Nov 2, 2023
32 checks passed
@Savio-Sou Savio-Sou deleted the ss/update-integer-docs branch November 2, 2023 20:01
@jfecher jfecher mentioned this pull request Nov 2, 2023
Closed
TomAFrench pushed a commit that referenced this pull request Nov 14, 2023
@Savio-Sou @signorecello
@jfecher @TomAFrench
chore(docs): Document signed integers and integer overflow behavior (#…
e0770a8 
…3393)

Co-authored-by: José Pedro Sousa <github@zepedro.me>
Co-authored-by: jfecher <jake@aztecprotocol.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@guipublic guipublic guipublic left review comments

@jfecher jfecher jfecher approved these changes

@signorecello signorecello Awaiting requested review from signorecello

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.
4 participants
@Savio-Sou @signorecello @jfecher @guipublic