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.

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

Fix Comment Syntax in Code Update storage.cairo #201

Open
wants to merge 1 commit into
base: master
Choose a base branch
from

Conversation

0xminds
Copy link

@0xminds 0xminds commented Nov 24, 2024

Summary:

This pull request addresses a syntax issue with comment formatting in the code. Specifically, it corrects the usage of // for comments, which was originally used in places where # should have been employed, following the conventions of StarkNet (or Cairo) language.

Issue:

The original code used the following comment syntax:

// Valid storage addresses should satisfy address + offset < 2**251 where
// offset < MAX_STORAGE_ITEM_SIZE and address < ADDR_BOUND.

However, in StarkNet and Cairo, comments should be written using #, not // (which is common in languages like JavaScript or Python). This inconsistency may cause confusion for developers working with the codebase, as it deviates from the expected conventions of the language.

Fix:

The comments have been updated to use the correct syntax, as shown below:

# Valid storage addresses should satisfy address + offset < 2**251 where
# offset < MAX_STORAGE_ITEM_SIZE and address < ADDR_BOUND.

Importance:

This change is important because adhering to the correct comment syntax is essential for maintaining consistency within the codebase. It ensures that developers using the StarkNet or Cairo environment can easily read and understand the code without confusion. Proper comment formatting also helps maintain the overall quality and readability of the code, especially in collaborative development environments.

Thank you for reviewing this change!
Love StarkNet!

This pull request addresses a syntax issue with comment formatting in the code. Specifically, it corrects the usage of // for comments, which was originally used in places where # should have been employed, following the conventions of StarkNet (or Cairo) language.
@reviewable-StarkWare
Copy link

This change is Reviewable

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.

2 participants