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

Encoding version 1 documentation #541

Merged
merged 6 commits into from
Jan 24, 2024
Merged

Encoding version 1 documentation #541

merged 6 commits into from
Jan 24, 2024

Conversation

xunilrj
Copy link
Contributor

@xunilrj xunilrj commented Jan 18, 2024

This PR has the first version of the documentation of the new encoding version 1.

@xunilrj xunilrj self-assigned this Jan 18, 2024
Copy link
Member

@digorithm digorithm left a comment

Choose a reason for hiding this comment

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

Thanks for doing this. I suggested a few changes to keep the consistency with the rest of the specs.

Also, I'd suggest prefacing/opening the Version 1 header with an explanation that it's an upgrade that will replace the original version, described above.

Maybe, in the future, once this is fully settled, we should delete the previous spec (the one above version 1).

src/abi/argument-encoding.md Outdated Show resolved Hide resolved
src/abi/argument-encoding.md Outdated Show resolved Hide resolved
src/abi/argument-encoding.md Outdated Show resolved Hide resolved
src/abi/argument-encoding.md Outdated Show resolved Hide resolved
src/abi/argument-encoding.md Outdated Show resolved Hide resolved
src/abi/argument-encoding.md Outdated Show resolved Hide resolved
src/abi/argument-encoding.md Outdated Show resolved Hide resolved
src/abi/argument-encoding.md Outdated Show resolved Hide resolved
src/abi/argument-encoding.md Outdated Show resolved Hide resolved
src/abi/argument-encoding.md Outdated Show resolved Hide resolved
@digorithm digorithm requested review from a team January 18, 2024 19:22
@xunilrj xunilrj dismissed digorithm’s stale review January 19, 2024 14:45

Changes were already incorporated.

Copy link

@hal3e hal3e left a comment

Choose a reason for hiding this comment

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

LGTM

Copy link
Member

@digorithm digorithm left a comment

Choose a reason for hiding this comment

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

Nice -- thanks for these changes!

@digorithm digorithm requested a review from arboleya January 24, 2024 15:23
@xunilrj xunilrj merged commit 6cd7270 into master Jan 24, 2024
6 checks passed
@xunilrj xunilrj deleted the xunilrj/new-encoding-doc branch January 24, 2024 16:23
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.

5 participants