update method docs

oceanprotocol · Aug 27, 2020 · 7078113 · 7078113
1 parent d47a9f0
commit 7078113
Show file tree

Hide file tree

Showing 2 changed files with 10 additions and 10 deletions.
diff --git a/src/balancer/OceanPool.ts b/src/balancer/OceanPool.ts
@@ -29,7 +29,7 @@ export class OceanPool extends Pool {
      * @param {String} token  DataToken address
      * @param {String} amount DataToken amount
      * @param {String} weight DataToken weight
-     * @param {String} fee    Swap fee in Wei
+     * @param {String} fee    Swap fee (as float)
      * @return {String}
      */
   public async createDTPool(

diff --git a/src/balancer/Pool.ts b/src/balancer/Pool.ts
@@ -39,15 +39,15 @@ export class Pool extends PoolFactory {
      * Setup a new pool by setting datatoken, base token, swap fee and
      * finalizing the pool to make it public.
      *
-     * @param account
-     * @param poolAddress
-     * @param dataToken
-     * @param dataTokenAmount
-     * @param dataTokenWeight
-     * @param baseToken
-     * @param baseTokenAmount
-     * @param baseTokenWeight
-     * @param swapFee
+     * @param {String} account ethereum address to use for sending this transaction
+     * @param {String} poolAddress address of new Balancer Pool
+     * @param {String} dataToken address of datatoken ERC20 contract
+     * @param {String} dataTokenAmount in wei
+     * @param {String} dataTokenWeight in wei
+     * @param {String} baseToken address of base token ERC20 contract
+     * @param {String} baseTokenAmount in wei
+     * @param {String} baseTokenWeight in wei
+     * @param {String} swapFee in wei
      */
   async setup(
     account: string,