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

sui-sdk-types: some refactors and doc additions #90

Merged
merged 9 commits into from
Jan 22, 2025
Merged

Conversation

bmwill
Copy link
Collaborator

@bmwill bmwill commented Jan 22, 2025

This PR includes a number of commits that:

  • Add docs to the top level of the crate
  • Adds docs to Address and a few related helper functions
  • configures rustfmt to format doc examples
  • renames the various to_address functions to derive_address

and it adds a bcs gaurentee and Closes #71

This is the beginning of an effort to better document the library, many more doc PRs are to come...

@bmwill bmwill merged commit 797f09b into master Jan 22, 2025
6 checks passed
@bmwill bmwill deleted the doc-updates branch January 22, 2025 20:47
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.

Question: BCS-compatibility guarantees
1 participant