Skip to content

Commit

Permalink
docs: improved wording and links
Browse files Browse the repository at this point in the history
  • Loading branch information
Chris-Hibbert committed Jan 22, 2025
1 parent 29e1dad commit 60fbdcd
Showing 1 changed file with 9 additions and 9 deletions.
18 changes: 9 additions & 9 deletions main/reference/zoe-api/zoe.md
Original file line number Diff line number Diff line change
Expand Up @@ -147,10 +147,11 @@ const invitationValue = await E(Zoe).getInvitationDetails(invitation);
- **bundleLabel**: string - Optional
- Returns: **Promise<Installation>**

Takes bundled source code for a Zoe contract as an argument and
installs the code with Zoe. The _bundleLabel_ will be accessible on the
**Installation** object. Returns a **Promise** for an **Installation**
object.
Create an installation by safely evaluating the code and registering it with Zoe. Returns a **Promise** for an
**Installation** object. The _bundleLabel_ will be accessible on the Installation using
`E(anInstallation).getBundleLabel()`.

`E(zoe).install()` is seldom used outside of test contexts. Consider using `E(zoe).installBundleID()` instead.

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

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

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

0 comments on commit 60fbdcd

Please sign in to comment.