rebuild docs

kp2r-network · Sep 4, 2020 · 82576db · 82576db
1 parent 5550280
commit 82576db
Show file tree

Hide file tree

Showing 10 changed files with 80 additions and 39 deletions.
diff --git a/docs/assets/js/search.json b/docs/assets/js/search.json
diff --git a/docs/modules/_api_.html b/docs/modules/_api_.html
@@ -92,7 +92,7 @@ <h3>account</h3>
 						<li class="tsd-description">
 							<aside class="tsd-sources">
 								<ul>
-									<li>Defined in <a href="https://github.com/compound-finance/compound-js/blob/8a48d19/src/api.ts#L60">api.ts:60</a></li>
+									<li>Defined in <a href="https://github.com/compound-finance/compound-js/blob/c06049c/src/api.ts#L60">api.ts:60</a></li>
 								</ul>
 							</aside>
 							<div class="tsd-comment tsd-typography">
@@ -150,7 +150,7 @@ <h3>c<wbr>Token</h3>
 						<li class="tsd-description">
 							<aside class="tsd-sources">
 								<ul>
-									<li>Defined in <a href="https://github.com/compound-finance/compound-js/blob/8a48d19/src/api.ts#L85">api.ts:85</a></li>
+									<li>Defined in <a href="https://github.com/compound-finance/compound-js/blob/c06049c/src/api.ts#L85">api.ts:85</a></li>
 								</ul>
 							</aside>
 							<div class="tsd-comment tsd-typography">
@@ -195,7 +195,7 @@ <h3>governance</h3>
 						<li class="tsd-description">
 							<aside class="tsd-sources">
 								<ul>
-									<li>Defined in <a href="https://github.com/compound-finance/compound-js/blob/8a48d19/src/api.ts#L141">api.ts:141</a></li>
+									<li>Defined in <a href="https://github.com/compound-finance/compound-js/blob/c06049c/src/api.ts#L141">api.ts:141</a></li>
 								</ul>
 							</aside>
 							<div class="tsd-comment tsd-typography">
@@ -248,7 +248,7 @@ <h3>market<wbr>History</h3>
 						<li class="tsd-description">
 							<aside class="tsd-sources">
 								<ul>
-									<li>Defined in <a href="https://github.com/compound-finance/compound-js/blob/8a48d19/src/api.ts#L113">api.ts:113</a></li>
+									<li>Defined in <a href="https://github.com/compound-finance/compound-js/blob/c06049c/src/api.ts#L113">api.ts:113</a></li>
 								</ul>
 							</aside>
 							<div class="tsd-comment tsd-typography">

diff --git a/docs/modules/_comp_.html b/docs/modules/_comp_.html
@@ -95,7 +95,7 @@ <h3>claim<wbr>Comp</h3>
 						<li class="tsd-description">
 							<aside class="tsd-sources">
 								<ul>
-									<li>Defined in <a href="https://github.com/compound-finance/compound-js/blob/8a48d19/src/comp.ts#L150">comp.ts:150</a></li>
+									<li>Defined in <a href="https://github.com/compound-finance/compound-js/blob/c06049c/src/comp.ts#L150">comp.ts:150</a></li>
 								</ul>
 							</aside>
 							<div class="tsd-comment tsd-typography">
@@ -138,7 +138,7 @@ <h3>create<wbr>Delegate<wbr>Signature</h3>
 						<li class="tsd-description">
 							<aside class="tsd-sources">
 								<ul>
-									<li>Defined in <a href="https://github.com/compound-finance/compound-js/blob/8a48d19/src/comp.ts#L330">comp.ts:330</a></li>
+									<li>Defined in <a href="https://github.com/compound-finance/compound-js/blob/c06049c/src/comp.ts#L330">comp.ts:330</a></li>
 								</ul>
 							</aside>
 							<div class="tsd-comment tsd-typography">
@@ -185,7 +185,7 @@ <h3>delegate</h3>
 						<li class="tsd-description">
 							<aside class="tsd-sources">
 								<ul>
-									<li>Defined in <a href="https://github.com/compound-finance/compound-js/blob/8a48d19/src/comp.ts#L190">comp.ts:190</a></li>
+									<li>Defined in <a href="https://github.com/compound-finance/compound-js/blob/c06049c/src/comp.ts#L190">comp.ts:190</a></li>
 								</ul>
 							</aside>
 							<div class="tsd-comment tsd-typography">
@@ -232,7 +232,7 @@ <h3>delegate<wbr>BySig</h3>
 						<li class="tsd-description">
 							<aside class="tsd-sources">
 								<ul>
-									<li>Defined in <a href="https://github.com/compound-finance/compound-js/blob/8a48d19/src/comp.ts#L253">comp.ts:253</a></li>
+									<li>Defined in <a href="https://github.com/compound-finance/compound-js/blob/c06049c/src/comp.ts#L253">comp.ts:253</a></li>
 								</ul>
 							</aside>
 							<div class="tsd-comment tsd-typography">
@@ -308,7 +308,7 @@ <h3>get<wbr>Comp<wbr>Accrued</h3>
 						<li class="tsd-description">
 							<aside class="tsd-sources">
 								<ul>
-									<li>Defined in <a href="https://github.com/compound-finance/compound-js/blob/8a48d19/src/comp.ts#L101">comp.ts:101</a></li>
+									<li>Defined in <a href="https://github.com/compound-finance/compound-js/blob/c06049c/src/comp.ts#L101">comp.ts:101</a></li>
 								</ul>
 							</aside>
 							<div class="tsd-comment tsd-typography">
@@ -355,7 +355,7 @@ <h3>get<wbr>Comp<wbr>Balance</h3>
 						<li class="tsd-description">
 							<aside class="tsd-sources">
 								<ul>
-									<li>Defined in <a href="https://github.com/compound-finance/compound-js/blob/8a48d19/src/comp.ts#L56">comp.ts:56</a></li>
+									<li>Defined in <a href="https://github.com/compound-finance/compound-js/blob/c06049c/src/comp.ts#L56">comp.ts:56</a></li>
 								</ul>
 							</aside>
 							<div class="tsd-comment tsd-typography">
@@ -402,7 +402,7 @@ <h3>to<wbr>Checksum<wbr>Address</h3>
 						<li class="tsd-description">
 							<aside class="tsd-sources">
 								<ul>
-									<li>Defined in <a href="https://github.com/compound-finance/compound-js/blob/8a48d19/src/comp.ts#L16">comp.ts:16</a></li>
+									<li>Defined in <a href="https://github.com/compound-finance/compound-js/blob/c06049c/src/comp.ts#L16">comp.ts:16</a></li>
 								</ul>
 							</aside>
 							<div class="tsd-comment tsd-typography">

diff --git a/docs/modules/_comptroller_.html b/docs/modules/_comptroller_.html
@@ -90,12 +90,12 @@ <h3>enter<wbr>Markets</h3>
 						<li class="tsd-description">
 							<aside class="tsd-sources">
 								<ul>
-									<li>Defined in <a href="https://github.com/compound-finance/compound-js/blob/8a48d19/src/comptroller.ts#L26">comptroller.ts:26</a></li>
+									<li>Defined in <a href="https://github.com/compound-finance/compound-js/blob/c06049c/src/comptroller.ts#L26">comptroller.ts:26</a></li>
 								</ul>
 							</aside>
 							<div class="tsd-comment tsd-typography">
 								<div class="lead">
-									<p>Enters the user&#39;s address into Compound protocol markets.</p>
+									<p>Enters the user&#39;s address into Compound Protocol markets.</p>
 								</div>
 								<dl class="tsd-comment-tags">
 									<dt>example</dt>
@@ -134,12 +134,12 @@ <h3>exit<wbr>Market</h3>
 						<li class="tsd-description">
 							<aside class="tsd-sources">
 								<ul>
-									<li>Defined in <a href="https://github.com/compound-finance/compound-js/blob/8a48d19/src/comptroller.ts#L83">comptroller.ts:83</a></li>
+									<li>Defined in <a href="https://github.com/compound-finance/compound-js/blob/c06049c/src/comptroller.ts#L83">comptroller.ts:83</a></li>
 								</ul>
 							</aside>
 							<div class="tsd-comment tsd-typography">
 								<div class="lead">
-									<p>Exits the user&#39;s address from a Compound protocol market.</p>
+									<p>Exits the user&#39;s address from a Compound Protocol market.</p>
 								</div>
 								<dl class="tsd-comment-tags">
 									<dt>example</dt>

diff --git a/docs/modules/_ctoken_.html b/docs/modules/_ctoken_.html
@@ -92,12 +92,12 @@ <h3>borrow</h3>
 						<li class="tsd-description">
 							<aside class="tsd-sources">
 								<ul>
-									<li>Defined in <a href="https://github.com/compound-finance/compound-js/blob/8a48d19/src/cToken.ts#L196">cToken.ts:196</a></li>
+									<li>Defined in <a href="https://github.com/compound-finance/compound-js/blob/c06049c/src/cToken.ts#L196">cToken.ts:196</a></li>
 								</ul>
 							</aside>
 							<div class="tsd-comment tsd-typography">
 								<div class="lead">
-									<p>Borrows an Ethereum asset from the Compound protocol for the user. The user&#39;s
+									<p>Borrows an Ethereum asset from the Compound Protocol for the user. The user&#39;s
 										address must first have supplied collateral and entered a corresponding
 									market.</p>
 								</div>
@@ -161,12 +161,12 @@ <h3>redeem</h3>
 						<li class="tsd-description">
 							<aside class="tsd-sources">
 								<ul>
-									<li>Defined in <a href="https://github.com/compound-finance/compound-js/blob/8a48d19/src/cToken.ts#L116">cToken.ts:116</a></li>
+									<li>Defined in <a href="https://github.com/compound-finance/compound-js/blob/c06049c/src/cToken.ts#L116">cToken.ts:116</a></li>
 								</ul>
 							</aside>
 							<div class="tsd-comment tsd-typography">
 								<div class="lead">
-									<p>Redeems the user&#39;s Ethereum asset from the Compound protocol.</p>
+									<p>Redeems the user&#39;s Ethereum asset from the Compound Protocol.</p>
 								</div>
 								<dl class="tsd-comment-tags">
 									<dt>example</dt>
@@ -224,7 +224,7 @@ <h3>repay<wbr>Borrow</h3>
 						<li class="tsd-description">
 							<aside class="tsd-sources">
 								<ul>
-									<li>Defined in <a href="https://github.com/compound-finance/compound-js/blob/8a48d19/src/cToken.ts#L264">cToken.ts:264</a></li>
+									<li>Defined in <a href="https://github.com/compound-finance/compound-js/blob/c06049c/src/cToken.ts#L264">cToken.ts:264</a></li>
 								</ul>
 							</aside>
 							<div class="tsd-comment tsd-typography">
@@ -293,12 +293,12 @@ <h3>supply</h3>
 						<li class="tsd-description">
 							<aside class="tsd-sources">
 								<ul>
-									<li>Defined in <a href="https://github.com/compound-finance/compound-js/blob/8a48d19/src/cToken.ts#L37">cToken.ts:37</a></li>
+									<li>Defined in <a href="https://github.com/compound-finance/compound-js/blob/c06049c/src/cToken.ts#L37">cToken.ts:37</a></li>
 								</ul>
 							</aside>
 							<div class="tsd-comment tsd-typography">
 								<div class="lead">
-									<p>Supplies the user&#39;s Ethereum asset to the Compound protocol.</p>
+									<p>Supplies the user&#39;s Ethereum asset to the Compound Protocol.</p>
 								</div>
 								<dl class="tsd-comment-tags">
 									<dt>example</dt>
@@ -309,7 +309,7 @@ <h3>supply</h3>
 
 (<span class="hljs-keyword">async</span> <span class="hljs-function"><span class="hljs-keyword">function</span>(<span class="hljs-params"></span>) </span>{
 
-  <span class="hljs-built_in">console</span>.log(<span class="hljs-string">&#x27;Supplying ETH to the Compound protocol...&#x27;</span>);
+  <span class="hljs-built_in">console</span>.log(<span class="hljs-string">&#x27;Supplying ETH to the Compound Protocol...&#x27;</span>);
   <span class="hljs-keyword">const</span> trx = <span class="hljs-keyword">await</span> compound.supply(Compound.ETH, <span class="hljs-number">1</span>);
   <span class="hljs-built_in">console</span>.log(<span class="hljs-string">&#x27;Ethers.js transaction object&#x27;</span>, trx);
 

diff --git a/docs/modules/_eth_.html b/docs/modules/_eth_.html
@@ -91,7 +91,7 @@ <h3>get<wbr>Balance</h3>
 						<li class="tsd-description">
 							<aside class="tsd-sources">
 								<ul>
-									<li>Defined in <a href="https://github.com/compound-finance/compound-js/blob/8a48d19/src/eth.ts#L261">eth.ts:261</a></li>
+									<li>Defined in <a href="https://github.com/compound-finance/compound-js/blob/c06049c/src/eth.ts#L261">eth.ts:261</a></li>
 								</ul>
 							</aside>
 							<div class="tsd-comment tsd-typography">
@@ -137,7 +137,7 @@ <h3>read</h3>
 						<li class="tsd-description">
 							<aside class="tsd-sources">
 								<ul>
-									<li>Defined in <a href="https://github.com/compound-finance/compound-js/blob/8a48d19/src/eth.ts#L147">eth.ts:147</a></li>
+									<li>Defined in <a href="https://github.com/compound-finance/compound-js/blob/c06049c/src/eth.ts#L147">eth.ts:147</a></li>
 								</ul>
 							</aside>
 							<div class="tsd-comment tsd-typography">
@@ -204,7 +204,7 @@ <h3>trx</h3>
 						<li class="tsd-description">
 							<aside class="tsd-sources">
 								<ul>
-									<li>Defined in <a href="https://github.com/compound-finance/compound-js/blob/8a48d19/src/eth.ts#L198">eth.ts:198</a></li>
+									<li>Defined in <a href="https://github.com/compound-finance/compound-js/blob/c06049c/src/eth.ts#L198">eth.ts:198</a></li>
 								</ul>
 							</aside>
 							<div class="tsd-comment tsd-typography">

diff --git a/docs/modules/_gov_.html b/docs/modules/_gov_.html
@@ -91,7 +91,7 @@ <h3>cast<wbr>Vote</h3>
 						<li class="tsd-description">
 							<aside class="tsd-sources">
 								<ul>
-									<li>Defined in <a href="https://github.com/compound-finance/compound-js/blob/8a48d19/src/gov.ts#L27">gov.ts:27</a></li>
+									<li>Defined in <a href="https://github.com/compound-finance/compound-js/blob/c06049c/src/gov.ts#L27">gov.ts:27</a></li>
 								</ul>
 							</aside>
 							<div class="tsd-comment tsd-typography">
@@ -141,7 +141,7 @@ <h3>cast<wbr>Vote<wbr>BySig</h3>
 						<li class="tsd-description">
 							<aside class="tsd-sources">
 								<ul>
-									<li>Defined in <a href="https://github.com/compound-finance/compound-js/blob/8a48d19/src/gov.ts#L85">gov.ts:85</a></li>
+									<li>Defined in <a href="https://github.com/compound-finance/compound-js/blob/c06049c/src/gov.ts#L85">gov.ts:85</a></li>
 								</ul>
 							</aside>
 							<div class="tsd-comment tsd-typography">
@@ -210,7 +210,7 @@ <h3>create<wbr>Vote<wbr>Signature</h3>
 						<li class="tsd-description">
 							<aside class="tsd-sources">
 								<ul>
-									<li>Defined in <a href="https://github.com/compound-finance/compound-js/blob/8a48d19/src/gov.ts#L154">gov.ts:154</a></li>
+									<li>Defined in <a href="https://github.com/compound-finance/compound-js/blob/c06049c/src/gov.ts#L154">gov.ts:154</a></li>
 								</ul>
 							</aside>
 							<div class="tsd-comment tsd-typography">

diff --git a/docs/modules/_index_.html b/docs/modules/_index_.html
@@ -89,7 +89,7 @@ <h3><span class="tsd-flag ts-flagConst">Const</span> <span class="tsd-flag ts-fl
 						<li class="tsd-description">
 							<aside class="tsd-sources">
 								<ul>
-									<li>Defined in <a href="https://github.com/compound-finance/compound-js/blob/8a48d19/src/index.ts#L45">index.ts:45</a></li>
+									<li>Defined in <a href="https://github.com/compound-finance/compound-js/blob/c06049c/src/index.ts#L45">index.ts:45</a></li>
 								</ul>
 							</aside>
 							<div class="tsd-comment tsd-typography">

diff --git a/docs/modules/_pricefeed_.html b/docs/modules/_pricefeed_.html
@@ -89,12 +89,12 @@ <h3>get<wbr>Price</h3>
 						<li class="tsd-description">
 							<aside class="tsd-sources">
 								<ul>
-									<li>Defined in <a href="https://github.com/compound-finance/compound-js/blob/8a48d19/src/priceFeed.ts#L76">priceFeed.ts:76</a></li>
+									<li>Defined in <a href="https://github.com/compound-finance/compound-js/blob/c06049c/src/priceFeed.ts#L76">priceFeed.ts:76</a></li>
 								</ul>
 							</aside>
 							<div class="tsd-comment tsd-typography">
 								<div class="lead">
-									<p>Gets an asset&#39;s price from the Compound protocol open price feed. The price
+									<p>Gets an asset&#39;s price from the Compound Protocol open price feed. The price
 										of the asset can be returned in any other supported asset value, including
 									all cTokens and underlyings.</p>
 								</div>