docs: minor fixups (#229)

q9f · Mar 25, 2023 · 3c3c806 · 3c3c806
1 parent b93b1ec
commit 3c3c806
Show file tree

Hide file tree

Showing 3 changed files with 15 additions and 6 deletions.
diff --git a/lib/eth/client.rb b/lib/eth/client.rb
@@ -174,7 +174,7 @@ def transfer_erc20_and_wait(erc20_contract, destination, amount, **kwargs)
     #   @param amount [Integer] the transfer amount (mind the `decimals()`).
     #   @param **sender_key [Eth::Key] the sender private key.
     #   @param **legacy [Boolean] enables legacy transactions (pre-EIP-1559).
-    #   @param **gas_limit [Integer] optional gas limit override for deploying the contract.
+    #   @param **gas_limit [Integer] optional gas limit override for the transfer.
     #   @param **nonce [Integer] optional specific nonce for transaction.
     #   @param **tx_value [Integer] optional transaction value field filling.
     # @return [Object] returns the result of the transaction.
@@ -252,7 +252,7 @@ def deploy(contract, *args, **kwargs)
     #   @param *args optional function arguments.
     #   @param **sender_key [Eth::Key] the sender private key.
     #   @param **legacy [Boolean] enables legacy transactions (pre-EIP-1559).
-    #   @param **gas_limit [Integer] optional gas limit override for deploying the contract.
+    #   @param **gas_limit [Integer] optional gas limit override for calling the contract.
     # @return [Object] returns the result of the call.
     def call(contract, function, *args, **kwargs)
       func = contract.functions.select { |func| func.name == function }
@@ -291,7 +291,7 @@ def call(contract, function, *args, **kwargs)
     #   @param **sender_key [Eth::Key] the sender private key.
     #   @param **legacy [Boolean] enables legacy transactions (pre-EIP-1559).
     #   @param **address [Eth::Address] contract address.
-    #   @param **gas_limit [Integer] optional gas limit override for deploying the contract.
+    #   @param **gas_limit [Integer] optional gas limit override for transacting with the contract.
     #   @param **nonce [Integer] optional specific nonce for transaction.
     #   @param **tx_value [Integer] optional transaction value field filling.
     # @return [Object] returns the result of the transaction.

diff --git a/lib/eth/contract.rb b/lib/eth/contract.rb
@@ -29,7 +29,7 @@ class Contract
 
     # Constructor of the {Eth::Contract} class.
     #
-    # Do not use this directly. Use
+    # **Note**, do not use this directly. Use
     # {from_abi}, {from_bin}, or {from_file}!
     #
     # @param name [String] contract name.

diff --git a/lib/eth/version.rb b/lib/eth/version.rb
@@ -15,6 +15,15 @@
 # Provides the {Eth} module.
 module Eth
 
-  # Defines the version of the {Eth} module.
-  VERSION = "0.5.11".freeze
+  # Defines the major version of the {Eth} module.
+  MAJOR = 0.freeze
+
+  # Defines the minor version of the {Eth} module.
+  MINOR = 5.freeze
+
+  # Defines the patch version of the {Eth} module.
+  PATCH = 11.freeze
+
+  # Defines the version string of the {Eth} module.
+  VERSION = [MAJOR, MINOR, PATCH].join(".").freeze
 end