Skip to content

docs: expand doc-comments on public functions in stats.rs (#702) - #724

Closed
ayomidearegbeshola29-dev wants to merge 1 commit into
Stellar-split:mainfrom
ayomidearegbeshola29-dev:fix/issue-702-stats-docs
Closed

docs: expand doc-comments on public functions in stats.rs (#702)#724
ayomidearegbeshola29-dev wants to merge 1 commit into
Stellar-split:mainfrom
ayomidearegbeshola29-dev:fix/issue-702-stats-docs

Conversation

@ayomidearegbeshola29-dev

Copy link
Copy Markdown

Expand doc-comments on public functions in stats.rs

Summary

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 parameters
or return values. This PR expands every public-function doc comment to describe
its env parameter, the semantic meaning of each numeric argument, and what the
returned Stats tuple represents, so callers and integrators can use the stats
module without reading the implementation.

What changed

  • get_stats — documents the (total_invoices, total_volume, total_recipients_paid)
    tuple layout and the env parameter.
  • increment — documents all four parameters and the StatsOverflow failure mode.
  • invoice_created / volume_added / recipients_paid — document parameters and
    return, including the InvalidAmount guard on volume_added.

The Stats type alias doc and all function bodies are unchanged.

Verification

Documentation-only; compiles unaffected. (CI on main is red for unrelated,
pre-existing reasons documented in the other split PRs.)

closes #702

@ayomidearegbeshola29-dev

Copy link
Copy Markdown
Author

Re-homed: PR now opened from assignee account christy-dev4.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Add doc-comments to public functions in stats.rs

1 participant