Skip to content

docs: field-level doc-comments for InvoiceOptions struct (#701) - #731

Merged
Kingsman-99 merged 1 commit into
Stellar-split:mainfrom
gabrielujelistic-collab:fix/issue-701-invoiceoptions-docs
Aug 30, 2026
Merged

docs: field-level doc-comments for InvoiceOptions struct (#701)#731
Kingsman-99 merged 1 commit into
Stellar-split:mainfrom
gabrielujelistic-collab:fix/issue-701-invoiceoptions-docs

Conversation

@gabrielujelistic-collab

Copy link
Copy Markdown

Add field-level doc-comments to InvoiceOptions

Summary

Closes #701

InvoiceOptions (contracts/split/src/types.rs) is the public input struct
callers fill in for create_invoice. Most fields already carried /// Issue #NN
notes, but four never-documented fields were left without any explanation. This
PR adds concise /// doc comments to those four fields: co_creators,
allow_early_withdrawal, bonus_pool, and bonus_max_payers.

What changed

  • co_creators — additional creators who share ownership/rights over the invoice.
  • allow_early_withdrawal — when true, payers may withdraw before the deadline.
  • bonus_pool — size of the bonus pool funded alongside the invoice.
  • bonus_max_payers — max distinct payers that may fund the bonus pool.

All other fields are unchanged (their existing issue-referenced comments remain).

Verification

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

closes #701

@drips-wave

drips-wave Bot commented Aug 29, 2026

Copy link
Copy Markdown

@gabrielujelistic-collab 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

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 field-level doc-comments to InvoiceOptions struct

2 participants