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

docs: normalize struct docs #507

Open
wants to merge 3 commits into
base: main
Choose a base branch
from
Open

docs: normalize struct docs #507

wants to merge 3 commits into from

Conversation

Emirhan-Cavusoglu-sftw
Copy link

Resolves #505

PR Checklist

  • Tests
  • Documentation
  • Changelog

@netlify Netlify
Copy link

netlify bot commented Jan 22, 2025 •
edited
Loading

✅ Deploy Preview for contracts-stylus canceled.

Name Link
🔨 Latest commit e9a32d2
🔍 Latest deploy log https://app.netlify.com/sites/contracts-stylus/deploys/67914f01249a9400085559bc

0xNeshi
0xNeshi reviewed Jan 22, 2025
View reviewed changes
Copy link
Collaborator

@0xNeshi 0xNeshi left a comment

Choose a reason for hiding this comment

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

Double check the docs in other contracts' structs, there are more occurrences

0xNeshi
0xNeshi reviewed Jan 22, 2025
View reviewed changes
Copy link
Collaborator

@0xNeshi 0xNeshi left a comment

Choose a reason for hiding this comment

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

Please double check other contracts' structs. Some of them are:

  • Erc721Enumerable
  • Erc1155UriStorage
  • Erc20Permit

You can do a global search from the root of the project and match #[storage], and just check if the docs above them need to be updated.

@bidzyyys bidzyyys changed the title [Feature]: Normalize Contract struct Docs docs: normalize struct docs Jan 27, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@0xNeshi 0xNeshi 0xNeshi left review comments

@bidzyyys bidzyyys Awaiting requested review from bidzyyys bidzyyys is a code owner

@qalisander qalisander Awaiting requested review from qalisander qalisander is a code owner

At least 2 approving reviews are required to merge this pull request.

Assignees

@Emirhan-Cavusoglu-sftw Emirhan-Cavusoglu-sftw

Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

[Feature]: Normalize Contract struct Docs
2 participants
@Emirhan-Cavusoglu-sftw @0xNeshi