docs: add rustdoc to DisputeManager public API#570
Merged
greatest0fallt1me merged 2 commits intoMay 27, 2026
Merged
Conversation
Complete the rustdoc coverage for disputes.rs: - claim_dispute_winnings: replace inline invariant comments with a proper doc block listing auth requirement and all error variants - DisputeManager timeout methods (set_dispute_timeout, check_dispute_timeout, auto_resolve_dispute_on_timeout, determine_timeout_outcome, emit_timeout_event, get_dispute_timeout_status, extend_dispute_timeout): expand one-liner stubs to include parameter intent, auth requirements, and typed error variants - get_dispute_votes / validate_dispute_resolution_conditions: expand stubs with error documentation - DisputeTimeout, DisputeTimeoutStatus, DisputeTimeoutOutcome, TimeoutStats, TimeoutAnalytics: replace minimal one-liners with concise descriptions linking to related functions - DisputeValidator, DisputeUtils, DisputeAnalytics structs: replace one-liners with short descriptions of their role and caller context - All DisputeUtils methods: replace one-liner stubs with accurate single-sentence descriptions; add missing docs to has_user_claimed_dispute, set_user_claimed_dispute, emit_dispute_vote_event, emit_fee_distribution_event, emit_dispute_escalation_event
|
@michaelvic123 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
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.
Closes #552
Summary
Completes rustdoc coverage for
disputes.rs. Every public item now has a///doc block.What changed
DisputeManagermethodsclaim_dispute_winnings: replaced inline invariant comments with a proper doc block — auth requirement, payout formula, and all error variantsset_dispute_timeout,check_dispute_timeout,auto_resolve_dispute_on_timeout,determine_timeout_outcome,emit_timeout_event,get_dispute_timeout_status,extend_dispute_timeout,get_dispute_votes,validate_dispute_resolution_conditions): expanded one-liner stubs with auth requirements and typed error variantsStructs / enums
DisputeTimeout,DisputeTimeoutStatus,DisputeTimeoutOutcome,TimeoutStats,TimeoutAnalytics: replaced minimal one-liners with concise descriptions linking to related functionsHelper structs
DisputeValidator,DisputeUtils,DisputeAnalytics: replaced one-liners with short role descriptionsDisputeUtilsmethodshas_user_claimed_dispute,set_user_claimed_dispute,emit_dispute_vote_event,emit_fee_distribution_event,emit_dispute_escalation_event: had no docs at all — addedAcceptance criteria
disputes.rshas a///doc blockreturn Err(...)paths in each functionrequire_auth()is called