From 2a58573823ecc2c59edf92ca462c8353d9ba15fc Mon Sep 17 00:00:00 2001 From: Chris Clark Date: Mon, 1 Aug 2016 11:53:46 -0700 Subject: [PATCH] Fix typos in docs --- docs/index.md | 4 ++-- docs/src/getBalanceSheet.md.ejs | 2 +- docs/src/prepareOrderCancellation.md.ejs | 2 +- 3 files changed, 4 insertions(+), 4 deletions(-) diff --git a/docs/index.md b/docs/index.md index de7b97c6..f4208824 100644 --- a/docs/index.md +++ b/docs/index.md @@ -1511,7 +1511,7 @@ options | object | *Optional* Options to determine how the balances will be calc ### Return Value -This method returns a promise that resolves with an array of objects with the following structure: +This method returns a promise that resolves with an object with the following structure: Name | Type | Description ---- | ---- | ----------- @@ -3051,7 +3051,7 @@ instructions | object | The instructions for how to execute the transaction afte ```javascript const address = 'r9cZA1mLK5R5Am25ArfXFmqgNwjZgnfk59'; const orderCancellation = {orderSequence: 123}; -return api.prepareOrderCancellation(address, sequence) +return api.prepareOrderCancellation(address, orderCancellation) .then(prepared => {/* ... */}); ``` diff --git a/docs/src/getBalanceSheet.md.ejs b/docs/src/getBalanceSheet.md.ejs index d6c3a9ae..b3aed116 100644 --- a/docs/src/getBalanceSheet.md.ejs +++ b/docs/src/getBalanceSheet.md.ejs @@ -10,7 +10,7 @@ Returns aggregate balances by currency plus a breakdown of assets and obligation ### Return Value -This method returns a promise that resolves with an array of objects with the following structure: +This method returns a promise that resolves with an object with the following structure: <%- renderSchema('output/get-balance-sheet.json') %> diff --git a/docs/src/prepareOrderCancellation.md.ejs b/docs/src/prepareOrderCancellation.md.ejs index dccd6ec7..96b30c27 100644 --- a/docs/src/prepareOrderCancellation.md.ejs +++ b/docs/src/prepareOrderCancellation.md.ejs @@ -23,7 +23,7 @@ All "prepare*" methods have the same return type. ```javascript const address = 'r9cZA1mLK5R5Am25ArfXFmqgNwjZgnfk59'; const orderCancellation = {orderSequence: 123}; -return api.prepareOrderCancellation(address, sequence) +return api.prepareOrderCancellation(address, orderCancellation) .then(prepared => {/* ... */}); ```