docs: add field-level doc-comments to InvoiceOptions (#701) - #723
Closed
ayomidearegbeshola29-dev wants to merge 1 commit into
Closed
Conversation
Author
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
1 participant
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.
Add field-level doc-comments to
InvoiceOptionsSummary
Closes #701
InvoiceOptions(contracts/split/src/types.rs) is the public input structcallers fill in for
create_invoice. Most fields already carried/// Issue #NNnotes, 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, andbonus_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
mainis red for unrelated,pre-existing reasons documented in the other split PRs.)
closes #701