From 2bf04170d7777e1cc1364acae23226d3b8ad3dcf Mon Sep 17 00:00:00 2001 From: alexcos20 Date: Mon, 13 Jul 2020 01:14:52 -0700 Subject: [PATCH] minor doc fix --- src/ocean/Compute.ts | 9 +++++---- 1 file changed, 5 insertions(+), 4 deletions(-) diff --git a/src/ocean/Compute.ts b/src/ocean/Compute.ts index 5796bd8f..6a7e8a9d 100644 --- a/src/ocean/Compute.ts +++ b/src/ocean/Compute.ts @@ -287,15 +287,16 @@ export class Compute extends Instantiable { /** * Starts an order of a compute service that is defined in an asset's services. - * @param {Account} consumerAccount The account of the consumer ordering the service. + * @param {String} consumerAccount The account of the consumer ordering the service. * @param {string} datasetDid The DID of the dataset asset (of type `dataset`) to run the algorithm on. + * @param {string} serviceIndex The Service index * @param {string} algorithmDid The DID of the algorithm asset (of type `algorithm`) to run on the asset. * @param {MetaData} algorithmMeta Metadata about the algorithm being run if `algorithm` is being used. This is ignored when `algorithmDid` is specified. - * @return {Promise} Returns the Service Agreement ID, representation of `bytes32` ID. + * @return {Promise} Returns the transaction details * * Note: algorithmDid and algorithmMeta are optional, but if they are not passed, - * you can end up in the situation that you are ordering and paying for your agreement, - * but brizo will not allow the compute, due to privacy settings of the ddo + * you can end up in the situation that you are ordering and paying for your compute job, + * but provider will not allow the compute, due to privacy settings of the ddo */ public order( consumerAccount: string,