Skip to content

Commit a21365f

Browse files
committed
docs: improved wording and links
1 parent 7b4f006 commit a21365f

File tree

1 file changed

+9
-9
lines changed

1 file changed

+9
-9
lines changed

main/reference/zoe-api/zoe.md

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -147,10 +147,11 @@ const invitationValue = await E(Zoe).getInvitationDetails(invitation);
147147
- **bundleLabel**: string - Optional
148148
- Returns: **Promise<Installation>**
149149

150-
Takes bundled source code for a Zoe contract as an argument and
151-
installs the code with Zoe. The _bundleLabel_ will be accessible on the
152-
**Installation** object. Returns a **Promise** for an **Installation**
153-
object.
150+
Create an installation by safely evaluating the code and registering it with Zoe. Returns a **Promise** for an
151+
**Installation** object. The _bundleLabel_ will be accessible on the Installation using
152+
`E(anInstallation).getBundleLabel()`.
153+
154+
`E(zoe).install()` is seldom used outside of test contexts. Consider using `E(zoe).installBundleID()` instead.
154155

155156
```js
156157
// bundleSource takes source code files and
@@ -166,11 +167,10 @@ const installationP = await E(Zoe).install(bundle);
166167
- **bundleLabel**: string - Optional
167168
- Returns: **Promise<Installation>**
168169

169-
Takes a bundleId for a Zoe contract (often generated in a [coreEval
170-
proposal](/guides/coreeval/local-testnet.html#deploying-contracts-using-core-eval-proposals)
171-
as an argument and installs the code with Zoe. The _bundleLabel_ will be
172-
accessible on the **Installation** object. Returns a **Promise** for
173-
an **Installation** object.
170+
Takes a bundleId for a Zoe contract (generated using a [builder
171+
script](/guides/zoe/contract-walkthru#bundling-a-contract) as an argument and installs the code with Zoe.
172+
Returns a **Promise** for an **Installation** object. The _bundleLabel_ will be accessible on the Installation using
173+
`E(anInstallation).getBundleLabel()`.
174174

175175
```js
176176
const installationP = await E(Zoe).installBundleID(bundleId, bundleLabel);

0 commit comments

Comments
 (0)