Skip to content

docs(streaming): add struct and field doc comments to CreateStreamParams (#473) - #581

Merged
Austinaminu2 merged 1 commit into
FlowwStar:mainfrom
Bilalishaq7:docs/add-create-stream-params-comments
Aug 24, 2026
Merged

Austinaminu2 merged 1 commit into
FlowwStar:mainfrom
Bilalishaq7:docs/add-create-stream-params-comments

Conversation

@Bilalishaq7

Copy link
Copy Markdown
Contributor

Closes #473

Summary

Added missing Rust doc comments (///) for CreateStreamParams struct and its fields in contracts/streaming/src/lib.rs.

Changes

  • Added struct-level description for CreateStreamParams.
  • Documented recipient, total_amount, start_time, stop_time, cliff_amount, and token_address fields.

@Bilalishaq7
Bilalishaq7 force-pushed the docs/add-create-stream-params-comments branch from d607a25 to 14b91a1 Compare August 24, 2026 21:18
@Bilalishaq7
Bilalishaq7 force-pushed the docs/add-create-stream-params-comments branch from 14b91a1 to 0e24856 Compare August 24, 2026 21:18
@Bilalishaq7
Bilalishaq7 force-pushed the docs/add-create-stream-params-comments branch from 0e24856 to 5cdf5e1 Compare August 24, 2026 21:20
@Bilalishaq7
Bilalishaq7 force-pushed the docs/add-create-stream-params-comments branch from 5cdf5e1 to 8a37272 Compare August 24, 2026 21:40
@Bilalishaq7
Bilalishaq7 force-pushed the docs/add-create-stream-params-comments branch from 4291171 to cfcc5ac Compare August 24, 2026 21:51
@Bilalishaq7
Bilalishaq7 force-pushed the docs/add-create-stream-params-comments branch from cfcc5ac to 8b525fe Compare August 24, 2026 21:51
@Austinaminu2
Austinaminu2 merged commit 1605298 into FlowwStar:main Aug 24, 2026
2 of 7 checks passed

This branch had an error being deployed

1 failed deployment
staging — 8b525fed Deployed Aug 24, 2026 by Bilalishaq7 via deploy-staging #184
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 CreateStreamParams

2 participants