Repository navigation
Conversation
- zoe-contract-facet: document registerFeeMint and setTestJig, fix makeZCFMint's 4th options param and makeEmptySeatKit's exit param. - zoe: fix "auction w ill" typo and getBundleIDFromInstallation, which is a real method, not reserved for future use. - zoe-helpers: satisfies returns 0|1, not Boolean; flag the atomicRearrange helper as deprecated in favor of zcf.atomicRearrange. - ratio-math: document ratioToNumber. - zoe-data-types: add PriceQuote, MutableQuote, ExitRule, and InvitationDetails entries, closing price-authority.md's broken #pricequote/#mutablequote cross-anchors. - price-authority: point at the new zoe-data-types entries instead of duplicating them. - mutable-quote: publish it (drop the "not included" banner) since its object-method docs aren't covered elsewhere. - index.md and the sidebar: wire price-authority, price-authority-admin, and mutable-quote in, and move price-authority off its previous unrelated home under "Deployed Zoe Contracts". - price-authority-admin: refresh the source permalink to a live commit.
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.
What
Fills in a handful of gaps in the Zoe API reference: documents
zcf.registerFeeMint()andzcf.setTestJig(), correctszcf.makeZCFMint()'s optionaloptionsparameter andzcf.makeEmptySeatKit()'s optionalexitparameter, addsratioToNumber()to the ratio math reference, and fixes a couple of inaccuracies (E(Zoe).getBundleIDFromInstallation()is a real method rather than reserved for future use, andsatisfies()returns0 | 1rather than aBoolean).It also adds
PriceQuote,MutableQuote,ExitRule, andInvitationDetailsentries to the Zoe data types page, which closes a couple of broken#pricequote/#mutablequotecross-links from the PriceAuthority page, and wires the PriceAuthority, PriceAuthority Admin, and MutableQuote pages into the Zoe API index and sidebar navigation (previously present but not linked from the landing page, and in the MutableQuote page's case, marked as excluded from publication).Why
A survey of the documentation site against the current
agoric-sdkZoe/ERTP source found these as the concrete gaps in an otherwise up-to-date reference cluster.What to attend to
The MutableQuote page's "not currently included" banner is removed since its content (the
cancel()/getPromise()/updateLevel()methods on the objectmutableQuoteWhen*()calls resolve to) is accurate against current source and isn't documented elsewhere; if there was a reason it was held back, that's worth surfacing in review.Out of scope
This PR does not touch the ERTP API reference cluster or any other reference page outside
reference/zoe-api/.