incorporate suggestions for method comments; add devdoc to dummy cont…

…ract
0xProject · Aug 2, 2019 · 792fe8e · 792fe8e
1 parent fe579be
commit 792fe8e
Show file tree

Hide file tree

Showing 27 changed files with 738 additions and 701 deletions.
diff --git a/packages/abi-gen-templates/partials/callAsync.handlebars b/packages/abi-gen-templates/partials/callAsync.handlebars
@@ -1,5 +1,5 @@
 /**
- * Calls the method
+ * Sends a read-only call to the contract method. Returns the result that would happen if one were to send an Ethereum transaction to this method, given the current state of the blockchain. Calls do not cost gas since they don't modify state.
 {{> params_docstring inputs=inputs docstrings=devdoc.params}}
 {{#if devdoc.return}}
  * @returns {{devdoc.return}}
@@ -43,7 +43,7 @@ async callAsync(
 },
 
 /**
- * Returns the ABI encoded transaction data
+ * Returns the ABI encoded transaction data needed to send an Ethereum tx calling this method. Before sending the Ethereum tx, this encoded tx data can first be sent to a separate signing service or can be used to create a 0x transaction (see protocol spec for more details).
 {{> params_docstring inputs=inputs docstrings=devdoc.params}}
  */
 getABIEncodedTransactionData(

diff --git a/packages/abi-gen-templates/partials/tx.handlebars b/packages/abi-gen-templates/partials/tx.handlebars
@@ -1,6 +1,6 @@
 public {{languageSpecificName}} = {
     /**
-     * Sends the transaction
+     * Sends an Ethereum transaction executing this method with the supplied parameters. This is a read/write Ethereum operation and will cost gas.
     {{> params_docstring inputs=inputs docstrings=devdoc.params}}
      * @param txData    Additional data for transaction
      * @returns         The hash of the transaction
@@ -34,7 +34,7 @@ public {{languageSpecificName}} = {
     return txHash;
     },
     /**
-     * Sends the transaction and wait for it to succeed
+     * Sends an Ethereum transaction and waits until the transaction has been successfully mined without reverting. If the transaction was mined, but reverted, an error is thrown.
     {{> params_docstring inputs=inputs docstrings=devdoc.params}}
      * @param txData                Additional data for transaction
      * @param pollingIntervalMs     Interval at which to poll for success
@@ -68,7 +68,7 @@ public {{languageSpecificName}} = {
     );
     },
     /**
-     * Estimate gas to send the transaction
+     * Estimates the gas cost of sending an Ethereum transaction calling this method with these arguments.
     {{> params_docstring inputs=inputs docstrings=devdoc.params}}
      * @param txData    Additional data for transaction
      * @returns         The hash of the transaction

diff --git a/packages/abi-gen-wrappers/src/generated-wrappers/asset_proxy_owner.ts b/packages/abi-gen-wrappers/src/generated-wrappers/asset_proxy_owner.ts
diff --git a/packages/abi-gen-wrappers/src/generated-wrappers/coordinator.ts b/packages/abi-gen-wrappers/src/generated-wrappers/coordinator.ts
diff --git a/packages/abi-gen-wrappers/src/generated-wrappers/coordinator_registry.ts b/packages/abi-gen-wrappers/src/generated-wrappers/coordinator_registry.ts