docs(escrow): update the module doc comment for crowdfunding - #194
Open
chmm195 wants to merge 1 commit into
Open
docs(escrow): update the module doc comment for crowdfunding#194chmm195 wants to merge 1 commit into
chmm195 wants to merge 1 commit into
Conversation
The top-of-file comment still described a single sponsor being refunded, which predates the contribution ledger added in MergeFi#57. refund() iterates every contribution and transfers each contributor their own amount. Describes the fund/contribute split as well, since 'sponsor-funded' read as one sponsor per issue. Closes MergeFi#157
|
@chmm195 is attempting to deploy a commit to the chonilius' projects Team on Vercel. A member of the Team first needs to authorize it. |
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
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.
Closes #157.
Comment-only change to
contracts/escrow/src/lib.rs; no code touched.One note on the wording. #157 suggests matching
milestones's comment, but the two contracts refund differently, so I did not copy it across:milestonesrefunds the unallocated remainder "in proportion to what they put in" — proportional, because the budget is allocated to issues in slices over time, so there may be less left than was contributed.escrowhas no partial allocation.refunditerates0..contributor_countand transfers eachContributionits own storedamount:So every contributor gets back exactly what they put in. Saying "in proportion" here would be true but weaker than the guarantee the code actually makes, so the comment says "the exact amount they put in".
I also reworded the opening line: "sponsor-funded" read as one sponsor per issue, so it now names the
fund/contributesplit explicitly.Left
release's andfund's own doc comments alone —fund's was already updated in4279873.