Expand docs for LTC1 and registry functions#29
Merged
Conversation
Add and enrich inline documentation across LTC1 and registry modules. In sources/ltc1.move: add module initializer docs, and detailed docstrings for create_contract and buy_token (arguments, aborts, and logic note about dividend‑stripping protection and investor purchase flow). In sources/registry.move: clarify register_notarization usage and rationale (why notarization id/hash are used), and expand claim_notarization docs with arguments, returns and abort conditions. These changes improve developer clarity around notarization, authorization, and token sale flows.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Add and enrich inline documentation across LTC1 and registry modules. In sources/ltc1.move: add module initializer docs, and detailed docstrings for create_contract and buy_token (arguments, aborts, and logic note about dividend‑stripping protection and investor purchase flow). In sources/registry.move: clarify register_notarization usage and rationale (why notarization id/hash are used), and expand claim_notarization docs with arguments, returns and abort conditions. These changes improve developer clarity around notarization, authorization, and token sale flows.