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

Documentation and some fixes along the way #70

Merged
merged 11 commits into from
Jun 27, 2024
Merged

Documentation and some fixes along the way #70

merged 11 commits into from
Jun 27, 2024

Conversation

gregnazario
Copy link
Contributor

Description

These are some updates for a 0.6.0 release. Planning on finishing up documentation in another PR.

  • Update changelog
  • [Breaking] Change type from Transaction to CommittedTransaction for cases that it's known they're committed
  • [Fix] Fix some of the API types that didn't match on-chain representations
  • Add Go doc for most functions and types in the codebase
  • Add tons more testing
  • [Breaking] Change ToAnyPublicKey to have an error in the output

Test Plan

See unit tests

Related Links

@gregnazario gregnazario requested a review from a team as a code owner June 27, 2024 01:25
@gregnazario gregnazario merged commit dfb0335 into main Jun 27, 2024
1 check passed
@gregnazario gregnazario deleted the documentation branch June 27, 2024 06:10
assert.Empty(t, data.Transactions)
}

func TestBlockWithTransactions(t *testing.T) {
Copy link
Contributor

Choose a reason for hiding this comment

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

copy-paste-o? looks the same as 'with NO transactions'

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Yeah I think my PR got too big, and I just cut it off. Just have missed this

@@ -1,3 +1,6 @@
// Package types is an internal package that contains the types used in the Aptos Go SDK.
Copy link
Contributor

Choose a reason for hiding this comment

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

I think the convention is for this kind of note to go in doc.go (with no other code content)

Copy link
Contributor Author

Choose a reason for hiding this comment

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

All the doc guides, don't give enough conventions, just worry about syntax. Will look into this

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