Adds documentation for the Web3j.shutdown method

santtu · Mar 20, 2018 · ee152f4 · ee152f4
1 parent 7ec488d
commit ee152f4
Show file tree

Hide file tree

Showing 2 changed files with 7 additions and 1 deletion.
diff --git a/core/src/main/java/org/web3j/protocol/Web3j.java b/core/src/main/java/org/web3j/protocol/Web3j.java
@@ -38,7 +38,7 @@ static Web3j build(
     }
 
     /**
-     * Shutdowns a Web3j instance and cleans up opened resources.
+     * Shutdowns a Web3j instance and closes opened resources.
      */
     void shutdown();
 }
diff --git a/docs/source/getting_started.rst b/docs/source/getting_started.rst
@@ -69,6 +69,12 @@ For further information refer to :doc:`infura`.
 Instructions on obtaining Ether to transact on the network can be found in the
 :ref:`testnet section of the docs <ethereum-testnets>`.
 
+When you no longer need a `Web3j` instance you need to call the `shutdown` method to close resources used by it.
+
+.. code-block:: java
+
+   web3.shutdown()
+
 
 Start sending requests
 ----------------------