Merge pull request #2235 from ethereum/documentation/improvements

documentation improvements
web3 · Jan 27, 2019 · 9151e9a · 9151e9a
2 parents 752df95 + a54a7d3
commit 9151e9a
Show file tree

Hide file tree

Showing 24 changed files with 89 additions and 176 deletions.
diff --git a/docs/_build/doctrees/environment.pickle b/docs/_build/doctrees/environment.pickle
diff --git a/docs/_build/doctrees/include_package-core.doctree b/docs/_build/doctrees/include_package-core.doctree
diff --git a/docs/_build/doctrees/web3-eth-accounts.doctree b/docs/_build/doctrees/web3-eth-accounts.doctree
diff --git a/docs/_build/doctrees/web3-eth-contract.doctree b/docs/_build/doctrees/web3-eth-contract.doctree
diff --git a/docs/_build/doctrees/web3-eth-personal.doctree b/docs/_build/doctrees/web3-eth-personal.doctree
diff --git a/docs/_build/doctrees/web3-eth.doctree b/docs/_build/doctrees/web3-eth.doctree
diff --git a/docs/_build/doctrees/web3-shh.doctree b/docs/_build/doctrees/web3-shh.doctree
diff --git a/docs/_build/doctrees/web3.doctree b/docs/_build/doctrees/web3.doctree
diff --git a/docs/_build/html/_sources/include_package-core.rst.txt b/docs/_build/html/_sources/include_package-core.rst.txt
@@ -1,8 +1,4 @@
 
-Web3 Module
-=====================
-
-
 options
 =====================
 

diff --git a/docs/_build/html/_sources/web3-eth-accounts.rst.txt b/docs/_build/html/_sources/web3-eth-accounts.rst.txt
@@ -2,9 +2,9 @@
 
 .. include:: include_announcement.rst
 
-=========
+=================
 web3.eth.accounts
-=========
+=================
 
 The ``web3.eth.accounts`` contains functions to generate Ethereum accounts and sign transactions and data.
 
@@ -28,7 +28,7 @@ To use this package standalone use:
 .. _accounts-create:
 
 create
-=====================
+======
 
 .. code-block:: javascript
 
@@ -92,9 +92,8 @@ Example
 
 ------------------------------------------------------------------------------
 
-
 privateKeyToAccount
-=====================
+===================
 
 .. code-block:: javascript
 
@@ -134,7 +133,7 @@ Example
 .. _eth-accounts-signtransaction:
 
 signTransaction
-=====================
+===============
 
 .. code-block:: javascript
 
@@ -211,9 +210,8 @@ Example
 
 ------------------------------------------------------------------------------
 
-
 recoverTransaction
-=====================
+==================
 
 .. code-block:: javascript
 
@@ -244,11 +242,10 @@ Example
     > "0xF0109fC8DF283027b6285cc889F5aA624EaC1F55"
 
 
-
 ------------------------------------------------------------------------------
 
 hashMessage
-=====================
+===========
 
 .. code-block:: javascript
 
@@ -289,7 +286,7 @@ Example
 .. _eth-accounts-sign:
 
 sign
-=====================
+====
 
 .. code-block:: javascript
 
@@ -339,7 +336,7 @@ Example
 .. _accounts-recover:
 
 recover
-=====================
+=======
 
 .. code-block:: javascript
 
@@ -396,7 +393,7 @@ Example
 
 
 encrypt
-=====================
+=======
 
 .. code-block:: javascript
 
@@ -450,7 +447,7 @@ Example
 ------------------------------------------------------------------------------
 
 decrypt
-=====================
+=======
 
 .. code-block:: javascript
 
@@ -511,7 +508,7 @@ Example
 .. _eth_accounts_wallet:
 
 wallet
-=====================
+======
 
 .. code-block:: javascript
 
@@ -548,7 +545,7 @@ Example
 ------------------------------------------------------------------------------
 
 wallet.create
-=====================
+=============
 
 .. code-block:: javascript
 
@@ -589,7 +586,7 @@ Example
 ------------------------------------------------------------------------------
 
 wallet.add
-=====================
+==========
 
 .. code-block:: javascript
 
@@ -644,7 +641,7 @@ Example
 ------------------------------------------------------------------------------
 
 wallet.remove
-=====================
+=============
 
 .. code-block:: javascript
 
@@ -692,7 +689,7 @@ Example
 
 
 wallet.clear
-=====================
+============
 
 .. code-block:: javascript
 
@@ -733,7 +730,7 @@ Example
 ------------------------------------------------------------------------------
 
 wallet.encrypt
-=====================
+==============
 
 .. code-block:: javascript
 
@@ -787,7 +784,7 @@ Example
 
 
 wallet.decrypt
-=====================
+==============
 
 .. code-block:: javascript
 
@@ -860,7 +857,7 @@ Example
 ------------------------------------------------------------------------------
 
 wallet.save
-=====================
+===========
 
 .. code-block:: javascript
 
@@ -897,7 +894,7 @@ Example
 ------------------------------------------------------------------------------
 
 wallet.load
-=====================
+===========
 
 .. code-block:: javascript
 

diff --git a/docs/_build/html/_sources/web3-eth-contract.rst.txt b/docs/_build/html/_sources/web3-eth-contract.rst.txt
@@ -2,9 +2,9 @@
 
 .. include:: include_announcement.rst
 
-========
+=================
 web3.eth.Contract
-========
+=================
 
 The ``web3.eth.Contract`` object makes it easy to interact with smart contracts on the ethereum blockchain.
 When you create a new contract object you give it the json interface of the respective smart contract
@@ -36,7 +36,7 @@ To use it standalone:
 
 
 new contract
-=========
+============
 
 .. index:: JSON interface
 

diff --git a/docs/_build/html/_sources/web3.rst.txt b/docs/_build/html/_sources/web3.rst.txt
@@ -5,16 +5,20 @@
 Web3
 ====
 
-
-    This's main class of anything related Ethereum.
+    The Web3 class is an wrapper to house all Ethereum related modules.
 
 .. code-block:: javascript
 
-    import Web3 from 'web3';
+    import {Web3} from 'web3';
+
+    // "Web3.providers.givenProvider" will be set if in an Ethereum supported browser.
+    const web3 = new Web3(Web3.givenProvider || 'ws://some.local-or-remote.node:8546');
 
-    > Web3.givenProvider
-    > Web3.providers
-    > Web3.modules
+    > web3.eth
+    > web3.shh
+    > web3.bzz
+    > web3.utils
+    > web3.version
 
 ------------------------------------------------------------------------------
 
@@ -60,31 +64,10 @@ Example
 
 .. include:: include_package-core.rst
 
-------------------------------------------------------------------------------
-
-Web3 Class
-============
-
-    The Web3 class is an wrapper to house all Ethereum related modules.
-
-.. code-block:: javascript
-
-    import {Web3} from 'web3';
-
-    // "Web3.providers.givenProvider" will be set if in an Ethereum supported browser.
-    const web3 = new Web3(Web3.givenProvider || 'ws://some.local-or-remote.node:8546');
-
-    > web3.eth
-    > web3.shh
-    > web3.bzz
-    > web3.utils
-    > web3.version
-
-
 ------------------------------------------------------------------------------
 
 version
-============
+=======
 
     Property of the Web3 class.
 
@@ -111,7 +94,6 @@ Example
     > "1.0.0"
 
 
-
 ------------------------------------------------------------------------------
 
 

diff --git a/docs/_build/html/include_package-core.html b/docs/_build/html/include_package-core.html
@@ -6,7 +6,7 @@
   <head>
     <meta http-equiv="X-UA-Compatible" content="IE=Edge" />
     <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
-    <title>Web3 Module &#8212; web3.js 1.0.0 documentation</title>
+    <title>options &#8212; web3.js 1.0.0 documentation</title>
     <link rel="stylesheet" href="_static/classic.css" type="text/css" />
     <link rel="stylesheet" href="_static/pygments.css" type="text/css" />
 
@@ -34,10 +34,7 @@ <h3>Navigation</h3>
         <div class="bodywrapper">
           <div class="body" role="main">
 
-  <div class="section" id="web3-module">
-<h1>Web3 Module<a class="headerlink" href="#web3-module" title="Permalink to this headline">¶</a></h1>
-</div>
-<div class="section" id="options">
+  <div class="section" id="options">
 <h1>options<a class="headerlink" href="#options" title="Permalink to this headline">¶</a></h1>
 <p>An Web3 module does provide several options for configuring the transaction confirmation worklfow or for defining default values.
 These are the currently available option properties on a Web3 module:</p>
@@ -362,8 +359,7 @@ <h2>Example<a class="headerlink" href="#id16" title="Permalink to this headline"
         <div class="sphinxsidebarwrapper">
   <h3><a href="index.html">Table of Contents</a></h3>
   <ul>
-<li><a class="reference internal" href="#">Web3 Module</a></li>
-<li><a class="reference internal" href="#options">options</a><ul>
+<li><a class="reference internal" href="#">options</a><ul>
 <li><a class="reference internal" href="#module-options">Module Options</a></li>
 <li><a class="reference internal" href="#example">Example</a></li>
 </ul>

diff --git a/docs/_build/html/index.html b/docs/_build/html/index.html
@@ -69,7 +69,6 @@ <h1>web3.js - Ethereum JavaScript API<a class="headerlink" href="#web3-js-ethere
 <ul>
 <li class="toctree-l1"><a class="reference internal" href="web3.html">Web3</a><ul>
 <li class="toctree-l2"><a class="reference internal" href="web3.html#web3-modules">Web3.modules</a></li>
-<li class="toctree-l2"><a class="reference internal" href="web3.html#web3-module">Web3 Module</a></li>
 <li class="toctree-l2"><a class="reference internal" href="web3.html#options">options</a></li>
 <li class="toctree-l2"><a class="reference internal" href="web3.html#defaultblock">defaultBlock</a></li>
 <li class="toctree-l2"><a class="reference internal" href="web3.html#defaultaccount">defaultAccount</a></li>
@@ -83,7 +82,6 @@ <h1>web3.js - Ethereum JavaScript API<a class="headerlink" href="#web3-js-ethere
 <li class="toctree-l2"><a class="reference internal" href="web3.html#givenprovider">givenProvider</a></li>
 <li class="toctree-l2"><a class="reference internal" href="web3.html#currentprovider">currentProvider</a></li>
 <li class="toctree-l2"><a class="reference internal" href="web3.html#batchrequest">BatchRequest</a></li>
-<li class="toctree-l2"><a class="reference internal" href="web3.html#web3-class">Web3 Class</a></li>
 <li class="toctree-l2"><a class="reference internal" href="web3.html#version">version</a></li>
 <li class="toctree-l2"><a class="reference internal" href="web3.html#utils">utils</a></li>
 </ul>
@@ -98,7 +96,6 @@ <h1>web3.js - Ethereum JavaScript API<a class="headerlink" href="#web3-js-ethere
 <li class="toctree-l2"><a class="reference internal" href="web3-eth.html#ens">ens</a></li>
 <li class="toctree-l2"><a class="reference internal" href="web3-eth.html#abi">abi</a></li>
 <li class="toctree-l2"><a class="reference internal" href="web3-eth.html#net">net</a></li>
-<li class="toctree-l2"><a class="reference internal" href="web3-eth.html#web3-module">Web3 Module</a></li>
 <li class="toctree-l2"><a class="reference internal" href="web3-eth.html#options">options</a></li>
 <li class="toctree-l2"><a class="reference internal" href="web3-eth.html#defaultblock">defaultBlock</a></li>
 <li class="toctree-l2"><a class="reference internal" href="web3-eth.html#defaultaccount">defaultAccount</a></li>
@@ -196,7 +193,6 @@ <h1>web3.js - Ethereum JavaScript API<a class="headerlink" href="#web3-js-ethere
 </ul>
 </li>
 <li class="toctree-l1"><a class="reference internal" href="web3-eth-personal.html">web3.eth.personal</a><ul>
-<li class="toctree-l2"><a class="reference internal" href="web3-eth-personal.html#web3-module">Web3 Module</a></li>
 <li class="toctree-l2"><a class="reference internal" href="web3-eth-personal.html#options">options</a></li>
 <li class="toctree-l2"><a class="reference internal" href="web3-eth-personal.html#defaultblock">defaultBlock</a></li>
 <li class="toctree-l2"><a class="reference internal" href="web3-eth-personal.html#defaultaccount">defaultAccount</a></li>
@@ -292,7 +288,6 @@ <h1>web3.js - Ethereum JavaScript API<a class="headerlink" href="#web3-js-ethere
 </ul>
 </li>
 <li class="toctree-l1"><a class="reference internal" href="web3-shh.html">web3.shh</a><ul>
-<li class="toctree-l2"><a class="reference internal" href="web3-shh.html#web3-module">Web3 Module</a></li>
 <li class="toctree-l2"><a class="reference internal" href="web3-shh.html#options">options</a></li>
 <li class="toctree-l2"><a class="reference internal" href="web3-shh.html#defaultblock">defaultBlock</a></li>
 <li class="toctree-l2"><a class="reference internal" href="web3-shh.html#defaultaccount">defaultAccount</a></li>

diff --git a/docs/_build/html/objects.inv b/docs/_build/html/objects.inv
@@ -3,8 +3,10 @@
 # Version: 1.0.0
 # The remainder of this file is compressed using zlib.
 xڝX]��6}ׯ0�O/���R
-{/!�@�ҽ��"۳�Jl�Xڛn~}G��m�c�%�s$�4�Ӳ7�d^v@dRU�״�:��e?�x����ԡvW�Կ��Y0��y�x�n#ۡ	�*�/���PJ�HE;������IR����{=>'%�낖�e�v�ad��K1�J��62:ٳΎn8�h�I)��h�r�HR�l����D���r�X��^�F�;E%w�����in�TA[��F���/E�`o]��?"M�X���B�U��'Y+:�uI��m�U��o��ۀ#�oR�qݙ����k��s{M	�z��4��g������3ƑԹ�F��\\Y��X�[z $�e+_C�d4�h?4�:/=�H�;i���U��@�� �f�ս��Vn�˓9��bczQ���&�F*��#�E��+�m��}�@��|�"�ۓ�Ă֔o����m��l���JU��r(I�k�J%:zA�X��d�{��]~��}��AB������U֪���
-:�zhx�t�)�W�T�q���/?����2�JkV=FRb�
-�ػ4"�o4�lY��w^�����0w82�\>zt.���C�~�t�j5~���������yHfE�ak�[!ˎs�B�v��sN����1��8Ӷ�6�=�O2ʾ�T9��g�lgv���R)iw]�c�V�.�R�1	�e}��_�9�p!�͖�3��E����� �bn���R"��G,_Du�a���aF�����"��|8W�dy�Q]��[�}���d�A�?H#�đ���X!�Rw�iw�*6thOF-y�_܁w���z���d8�XLf&*H��)�Lf?�.xf�hW�g�gmx��G<C�6X�L�!Ƅ�,֍� C�˅bgVR���]V���$]ձ,s�ŢLn��)����i�y�אO_T
-|���+}�F��b]���������ױ�L9�"�B�?#�C/^O�/�1$�v�lc'P�4X(�H\{��&���Iݒ��EM$�]oRa$U�G���I��'|U�s���$/$,=�d-q��$�Px�C&q$��^�w��s��>ƽN�B�	��\䪣Z.!3W�LEl=��H���
-��2i�\ٗ԰�_,eZf;�5 n+��Hfg/�4'��̺��I�f��j��s����1Ezt�GK� u݇W������*��,[���p%-ܴ����ȸ
+{/!�@�ҽ��"۳�Jl�Xڛn~}G��m�c�5:�HiF#Ӳ7�d^v@dRU�״�:��e?�x����ԡvW�Կ��Y0�漃R�B���ЄV�\��(�{�������otw�$)~�L�V��II뺠�w���h���+�T���͂�N�컳���>�nR
+�:Z�ҁ�3��0?-�*&��9V/�'�Q�A��䮹1_;��*hkqߨ��<२��Ӱ��C�)k�\�|����D#oE�.	��m<����p$�M
+�3��;��}M>xn�)�Wou���L���619���3�����C��+˞KxO�$�l�k蔌�����@�g�� �Q��ݰ
+����D�����Z���j�&�<���-6��(�o"?i���;�3�$F~۱r��G�,P�'/"�5IO,hM���,.����I��h�T��,��ԹF�T����!O�W��巌�7$DQ�N�Pou`�zx:��s񨻆GI[\Ja�b8�z�{�;|��^ O��WZ��1��g��ޕ}�K�8`����R�\�n������Z��ңs5�������0T��;�m��e��u�C2+{K�
+Yv���B��	�ܮ�9�_�c���J�Zm�{ПdT}ǥr�0�>Ycv�Fr������������Ԁk\�xY�*��r�ɨ�\
+s�����p�)�j�3��X�cn����H�oE\	7Q�0#��A{�P�~7>l�{�dy�Q]��[�}���d�@�?H#��v���wX�/����66��0ņN�Ɍ%��+��~UOb;�������D	��1O7S��ˏ;�f	�+GE��Y�l�����=�k�q!?�u'"�B�r�ؙ��ި&t�U�F��Iw\�e�����@��bu
+m��:M3/��髃J�7!Swy���H{B��+�>�a��:P�:��)G_�_�G�H����_��^C�/K��'v�ׂ�b���<��e�2y����&�7y]$UO�^�ٙI\�'���碅j�$/+=�T,q��$�Txh!�<���L/��dz�&e�q��V�1	z�������{�LE�[&!��[3пd���'_R�>�b���2�Q�q[qMD2+{��9a<�g�54"7�?GT3���u��ѣ�?Z�`��><���_U1�e��"}>���,i�M��^��

diff --git a/docs/_build/html/searchindex.js b/docs/_build/html/searchindex.js
diff --git a/docs/_build/html/web3-eth-personal.html b/docs/_build/html/web3-eth-personal.html
@@ -67,9 +67,6 @@ <h1>web3.eth.personal<a class="headerlink" href="#web3-eth-personal" title="Perm
 </pre></div>
 </div>
 <hr class="docutils" />
-<div class="section" id="web3-module">
-<h2>Web3 Module<a class="headerlink" href="#web3-module" title="Permalink to this headline">¶</a></h2>
-</div>
 <div class="section" id="options">
 <h2>options<a class="headerlink" href="#options" title="Permalink to this headline">¶</a></h2>
 <p>An Web3 module does provide several options for configuring the transaction confirmation worklfow or for defining default values.
@@ -705,7 +702,6 @@ <h3>Example<a class="headerlink" href="#id42" title="Permalink to this headline"
   <h3><a href="index.html">Table of Contents</a></h3>
   <ul>
 <li><a class="reference internal" href="#">web3.eth.personal</a><ul>
-<li><a class="reference internal" href="#web3-module">Web3 Module</a></li>
 <li><a class="reference internal" href="#options">options</a><ul>
 <li><a class="reference internal" href="#module-options">Module Options</a></li>
 <li><a class="reference internal" href="#example">Example</a></li>