docs: document propchain-contracts public API — 9 missing ink! message doc comments ( - #1067
Open
Ummi-001 wants to merge 1 commit into
Open
docs: document propchain-contracts public API — 9 missing ink! message doc comments (#1067Ummi-001 wants to merge 1 commit into
Ummi-001 wants to merge 1 commit into
Conversation
|
@Ummi-001 Great news! 🎉 Based on an automated assessment of this PR, the linked Wave issue(s) no longer count against your application limits. You can now already apply to more issues while waiting for a review of this PR. Keep up the great work! 🚀 |
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
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.
Closes #961
Closes #962
Closes #963
Closes #964
What
Adds
///doc comments to the 9#[ink(message)]entry points incontracts/lib/src/lib.rsthat were missing documentation:Each comment covers what the message does, caller/role requirements,
and the error variants it can return.
Why
propchain-contractsis the crate thatdocs.ymlpublishes as therustdoc landing page. These 9 messages were the only gap in its
public API docs.
Scope
Documentation only — no behavior changes, no SDK regeneration.
Testing
cargo doc -p propchain-contracts --no-depsbuilds cleancargo test -p propchain-contractspasses