From a357c2f617724748b3313ad2775b9463421e5cbc Mon Sep 17 00:00:00 2001 From: Dhaiwat Pandya Date: Wed, 22 Dec 2021 18:32:04 +0530 Subject: [PATCH] Update docstrings --- packages/hooks/src/hooks/useTransaction.ts | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/packages/hooks/src/hooks/useTransaction.ts b/packages/hooks/src/hooks/useTransaction.ts index b4bd5864..c286af18 100644 --- a/packages/hooks/src/hooks/useTransaction.ts +++ b/packages/hooks/src/hooks/useTransaction.ts @@ -2,16 +2,16 @@ import React from 'react'; /** * @dev Hook to get the loading status, error, and data of a function call. - * @param method Function to call - * @param args an array of arguments to pass to the function + * @param method The contract function you want to call + * @param args an array of arguments to pass to the function. * @returns { * execute: () => Promise, * loading: boolean, * error: null | Error, * } { - * execute: On calling this method, the function is executed with the passed arguments and the loading status is set to true. - * loading: this is true while the function is executing and will be false when the function has finished executing., - * error: this will be null when there is no error and in case of error, it will contain the error object. + * execute: Executes the transaction. + * loading: True until the the transaction is confirmed, false otherwise. + * error: Contains the error object if the transaction failed, null otherwise. * } */