docs: add doc-comments to public functions in stats.rs (#702) - #732
Merged
Kingsman-99 merged 1 commit intoAug 30, 2026
Merged
Conversation
|
@christy-dev4 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.
Expand doc-comments on public functions in
stats.rsSummary
Closes #702
The public functions in
contracts/split/src/stats.rs(
get_stats,increment,invoice_created,volume_added,recipients_paid) had brief doc comments but none documented their parametersor return values. This PR expands every public-function doc comment to describe
its
envparameter, the semantic meaning of each numeric argument, and what thereturned
Statstuple represents, so callers and integrators can use the statsmodule without reading the implementation.
What changed
get_stats— documents the(total_invoices, total_volume, total_recipients_paid)tuple layout and the
envparameter.increment— documents all four parameters and theStatsOverflowfailure mode.invoice_created/volume_added/recipients_paid— document parameters andreturn, including the
InvalidAmountguard onvolume_added.The
Statstype alias doc and all function bodies are unchanged.Verification
Documentation-only; compiles unaffected. (CI on
mainis red for unrelated,pre-existing reasons documented in the other split PRs.)
closes #702