Skip to content

Commit 5e72089

Browse files
author
Chris Clark
committed
Fix prepareOrderCancellation documentation
1 parent 27ed1aa commit 5e72089

File tree

3 files changed

+6
-6
lines changed

3 files changed

+6
-6
lines changed

docs/index.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -2864,7 +2864,7 @@ instructions | [instructions](#transaction-instructions) | *Optional* Instructio
28642864
This method returns a promise that resolves with an object with the following structure:
28652865

28662866
<aside class="notice">
2867-
All "prepare" methods have the same return type.
2867+
All "prepare*" methods have the same return type.
28682868
</aside>
28692869

28702870
Name | Type | Description
@@ -2912,7 +2912,7 @@ return api.prepareOrder(address, order)
29122912

29132913
## prepareOrderCancellation
29142914

2915-
`prepareOrderCancellation(address: string, sequence: number, instructions: Object): Promise<Object>`
2915+
`prepareOrderCancellation(address: string, orderCancellation: Object, instructions: Object): Promise<Object>`
29162916

29172917
Prepare an order cancellation transaction. The prepared transaction must subsequently be [signed](#sign) and [submitted](#submit).
29182918

@@ -2929,7 +2929,7 @@ instructions | [instructions](#transaction-instructions) | *Optional* Instructio
29292929
This method returns a promise that resolves with an object with the following structure:
29302930

29312931
<aside class="notice">
2932-
All "prepare" methods have the same return type.
2932+
All "prepare*" methods have the same return type.
29332933
</aside>
29342934

29352935
Name | Type | Description

docs/src/prepareOrder.md.ejs

+1-1
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ Prepare an order transaction. The prepared transaction must subsequently be [sig
1313
This method returns a promise that resolves with an object with the following structure:
1414

1515
<aside class="notice">
16-
All "prepare" methods have the same return type.
16+
All "prepare*" methods have the same return type.
1717
</aside>
1818

1919
<%- renderSchema('output/prepare.json') %>

docs/src/prepareOrderCancellation.md.ejs

+2-2
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
## prepareOrderCancellation
22

3-
`prepareOrderCancellation(address: string, sequence: number, instructions: Object): Promise<Object>`
3+
`prepareOrderCancellation(address: string, orderCancellation: Object, instructions: Object): Promise<Object>`
44

55
Prepare an order cancellation transaction. The prepared transaction must subsequently be [signed](#sign) and [submitted](#submit).
66

@@ -13,7 +13,7 @@ Prepare an order cancellation transaction. The prepared transaction must subsequ
1313
This method returns a promise that resolves with an object with the following structure:
1414

1515
<aside class="notice">
16-
All "prepare" methods have the same return type.
16+
All "prepare*" methods have the same return type.
1717
</aside>
1818

1919
<%- renderSchema("output/prepare.json") %>

0 commit comments

Comments
 (0)