docs: comprehensive doc comments on all event structs and emitters in events.rs - #105
Merged
Conversation
MarcusDavidG
commented
Aug 18, 2026
MarcusDavidG
commented
Contributor
- Module-level doc comment explaining event topic convention and indexer usage
- Each struct gets a doc comment explaining when it fires and field semantics
- Each emitter function gets a doc comment with topic string and call sites
- Covers: created, payment, released, refunded, pyr, dispute, dsprslv, claimed, cancel, esc_fund
- 83 tests passing
…ctions in events.rs
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
1 participant
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.