docs: drop all references to reallocate() and its helpers #1266
Conversation
This file contains 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
dckc
approved these changes
Jan 22, 2025
| contract-->>-zoe: reallocate() | ||
| contract-->>-zoe: atomicRearrange() |
There was a problem hiding this comment.
the corresponding .svg should be regenerated.
it shows up in Specifying Offers
https://10871-excisereallocate.documentation-7tp.pages.dev/assets/zoe-simp.1Ml6HzzR.svg
Crud: CONTRIBUTING.md doesn't say how. IOU, I suppose.
In brief: I use Mermaid Editor - Visual Studio Marketplace.
There was a problem hiding this comment.
That page also has a link to a web editor which works fine for small diagrams like this, and allowed me to save as svg.
main/guides/zoe/index.md
Outdated
| @@ -21,7 +21,7 @@ Trading with a contract using Zoe typically goes through these steps: | |||
| 1. Parties call [E(zoe).offer(invitation, proposal, assets)](/reference/zoe-api/zoe#e-zoe-offer-invitation-proposal-paymentpkeywordrecord-offerargs). Zoe escrows the assets. | |||
| 2. Zoe relays the proposal to the contract identified in the invitation. | |||
| 3. The contract handles proposals using its custom business logic. | |||
| 4. The contract instructs Zoe to [reallocate](/reference/zoe-api/zoe-contract-facet#zcf-reallocate-seats) assets among the parties. | |||
| 4. The contract instructs Zoe to [reallocate](/reference/zoe-api/zoe-contract-facet.html#zcf-atomicrearrange-transfers) assets among the parties. | |||
There was a problem hiding this comment.
Suggested change
| 4. The contract instructs Zoe to [reallocate](/reference/zoe-api/zoe-contract-facet.html#zcf-atomicrearrange-transfers) assets among the parties. | |
| 4. The contract instructs Zoe to [reallocate](/reference/zoe-api/zoe-contract-facet#zcf-atomicrearrange-transfers) assets among the parties. |
Deploying documentation with
|
| Latest commit: |
0156fd8
|
| Status: | ✅ Deploy successful! |
| Preview URL: | https://f7ae1ed6.documentation-7tp.pages.dev |
| Branch Preview URL: | https://10871-excisereallocate.documentation-7tp.pages.dev |
|
Cloudflare deployment logs are available here |
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: #798
See #10871
We converted from
zcf.reallocate()tozcf.atomicRearrange()over the course of several releases. The old code will be completely gone as of #10871. This PR cleans up the last of the remaining documentation.