Skip to content

doc: fix type-layout.adoc clarity (u256 hex, enum selector, snapshot)#9766

Merged
eytan-starkware merged 1 commit into
mainfrom
eytan_graphite/doc_fix_type-layout.adoc_clarity_u256_hex_enum_selector_snapshot_
May 14, 2026
Merged

doc: fix type-layout.adoc clarity (u256 hex, enum selector, snapshot)#9766
eytan-starkware merged 1 commit into
mainfrom
eytan_graphite/doc_fix_type-layout.adoc_clarity_u256_hex_enum_selector_snapshot_

Conversation

@eytan-starkware
Copy link
Copy Markdown
Contributor

No description provided.

@reviewable-StarkWare
Copy link
Copy Markdown

This change is Reviewable

Copy link
Copy Markdown
Contributor Author

This stack of pull requests is managed by Graphite. Learn more about stacking.

@eytan-starkware eytan-starkware marked this pull request as ready for review May 14, 2026 10:44
@cursor
Copy link
Copy Markdown

cursor Bot commented May 14, 2026

PR Summary

Low Risk
Documentation-only edits with no runtime or API impact; low risk aside from potential reader confusion if the new examples are incorrect.

Overview
Updates type-layout.adoc to fix the u256 256-bit hex example so the shown low/high 128-bit limbs match the stated memory layout.

Rewords the Snapshot<T> section to explicitly state that @T stores a full copy (not a pointer/reference) and explains that this is why snapshots are always Copy-able even when T is not.

Reviewed by Cursor Bugbot for commit 865c0b9. Bugbot is set up for automated code reviews on this repo. Configure here.

Copy link
Copy Markdown
Collaborator

@orizi orizi left a comment

Choose a reason for hiding this comment

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

@orizi reviewed 1 file and all commit messages, and made 1 comment.
Reviewable status: all files reviewed, 1 unresolved discussion (waiting on eytan-starkware and TomerStarkware).


docs/reference/src/components/cairo/modules/language_constructs/pages/type-layout.adoc line 120 at r1 (raw file):

- **1-2 variants:** Selector is the variant index (0 or 1)
- **3+ variants:** Selector is a felt252-encoded jump offset used by the runtime

Suggestion:

- **3+ variants:** Selector is a jump offset used by the runtime

@eytan-starkware eytan-starkware force-pushed the eytan_graphite/doc_fix_type-layout.adoc_clarity_u256_hex_enum_selector_snapshot_ branch from 3accba1 to 865c0b9 Compare May 14, 2026 10:53
Copy link
Copy Markdown
Contributor Author

@eytan-starkware eytan-starkware left a comment

Choose a reason for hiding this comment

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

@eytan-starkware made 1 comment.
Reviewable status: all files reviewed, 1 unresolved discussion (waiting on orizi and TomerStarkware).


docs/reference/src/components/cairo/modules/language_constructs/pages/type-layout.adoc line 120 at r1 (raw file):

- **1-2 variants:** Selector is the variant index (0 or 1)
- **3+ variants:** Selector is a felt252-encoded jump offset used by the runtime

Done.

Copy link
Copy Markdown
Collaborator

@orizi orizi left a comment

Choose a reason for hiding this comment

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

:lgtm:

@orizi reviewed 1 file and all commit messages, made 1 comment, and resolved 1 discussion.
Reviewable status: :shipit: complete! all files reviewed, all discussions resolved (waiting on TomerStarkware).

@eytan-starkware eytan-starkware added this pull request to the merge queue May 14, 2026
Copy link
Copy Markdown
Collaborator

@TomerStarkware TomerStarkware left a comment

Choose a reason for hiding this comment

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

:lgtm:

@TomerStarkware made 1 comment.
Reviewable status: :shipit: complete! all files reviewed, all discussions resolved (waiting on eytan-starkware).

Merged via the queue into main with commit ca369c9 May 14, 2026
54 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants