Skip to content

docs: document the StreamStatus variants - #202

Merged
Glittersup merged 1 commit into
TricklePay:mainfrom
Yerimahjr:docs/issue-150
Aug 30, 2026
Merged

docs: document the StreamStatus variants#202
Glittersup merged 1 commit into
TricklePay:mainfrom
Yerimahjr:docs/issue-150

Conversation

@Yerimahjr

Copy link
Copy Markdown
Contributor

Summary

Closes #150. Documents each StreamStatus variant with the exact condition it represents, matching the logic in status().

Changes

  • Pending / Streaming / Completed: doc comments now state the precise ledger-time boundary (start_time, end_time) instead of loose phrasing.
  • Cancelled: doc comment now states how it interacts with the time-based variants — status() checks cancelled before any time comparison, so once a stream is cancelled it reports Cancelled permanently regardless of ledger time. Also notes cancellation can only happen from Pending or Streaming, since cancel() rejects once now >= end_time.

Scope

Comment-only change in contracts/stream/src/types.rs. No logic, tests, or public API touched.

Test results

  • cargo fmt --check — clean
  • cargo clippy --all-targets -- -D warnings — clean
  • cargo test — 105 passed, 0 failed, 0 ignored

@drips-wave

drips-wave Bot commented Aug 30, 2026

Copy link
Copy Markdown

@Yerimahjr 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! 🚀

Learn more about application limits

@Glittersup
Glittersup merged commit 592f680 into TricklePay:main Aug 30, 2026
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 the StreamStatus variants

2 participants