auto-docs

kp2r-network · Sep 9, 2020 · 0d9a675 · 0d9a675
1 parent ecc1c42
commit 0d9a675
Show file tree

Hide file tree

Showing 28 changed files with 451 additions and 104 deletions.
diff --git a/.gitignore b/.gitignore
@@ -1,3 +1,4 @@
 .DS_Store
 node_modules/
 dist/
+scripts/out.md
diff --git a/docs/globals.html b/docs/globals.html
@@ -3,8 +3,8 @@
 <head>
 	<meta charset="utf-8">
 	<meta http-equiv="X-UA-Compatible" content="IE=edge">
-	<title>Compound.js - v0.1.1</title>
-	<meta name="description" content="Documentation for Compound.js - v0.1.1">
+	<title>Compound.js - v0.1.2</title>
+	<meta name="description" content="Documentation for Compound.js - v0.1.2">
 	<meta name="viewport" content="width=device-width, initial-scale=1">
 	<link rel="stylesheet" href="assets/css/main.css">
 </head>
@@ -22,7 +22,7 @@
 						<li class="state loading">Preparing search index...</li>
 						<li class="state failure">The search index is not available</li>
 					</ul>
-					<a href="index.html" class="title">Compound.js - v0.1.1</a>
+					<a href="index.html" class="title">Compound.js - v0.1.2</a>
 				</div>
 				<div class="table-cell" id="tsd-widgets">
 					<div id="tsd-filter">
@@ -54,7 +54,7 @@
 					<a href="globals.html">Globals</a>
 				</li>
 			</ul>
-			<h1>Compound.js - v0.1.1</h1>
+			<h1>Compound.js - v0.1.2</h1>
 		</div>
 	</div>
 </header>

diff --git a/docs/index.html b/docs/index.html
@@ -3,8 +3,8 @@
 <head>
 	<meta charset="utf-8">
 	<meta http-equiv="X-UA-Compatible" content="IE=edge">
-	<title>Compound.js - v0.1.1</title>
-	<meta name="description" content="Documentation for Compound.js - v0.1.1">
+	<title>Compound.js - v0.1.2</title>
+	<meta name="description" content="Documentation for Compound.js - v0.1.2">
 	<meta name="viewport" content="width=device-width, initial-scale=1">
 	<link rel="stylesheet" href="assets/css/main.css">
 </head>
@@ -22,7 +22,7 @@
 						<li class="state loading">Preparing search index...</li>
 						<li class="state failure">The search index is not available</li>
 					</ul>
-					<a href="index.html" class="title">Compound.js - v0.1.1</a>
+					<a href="index.html" class="title">Compound.js - v0.1.2</a>
 				</div>
 				<div class="table-cell" id="tsd-widgets">
 					<div id="tsd-filter">
@@ -54,7 +54,7 @@
 					<a href="globals.html">Globals</a>
 				</li>
 			</ul>
-			<h1>Compound.js - v0.1.1</h1>
+			<h1>Compound.js - v0.1.2</h1>
 		</div>
 	</div>
 </header>

diff --git a/docs/modules/_api_.html b/docs/modules/_api_.html
@@ -3,8 +3,8 @@
 <head>
 	<meta charset="utf-8">
 	<meta http-equiv="X-UA-Compatible" content="IE=edge">
-	<title>&quot;api&quot; | Compound.js - v0.1.1</title>
-	<meta name="description" content="Documentation for Compound.js - v0.1.1">
+	<title>&quot;api&quot; | Compound.js - v0.1.2</title>
+	<meta name="description" content="Documentation for Compound.js - v0.1.2">
 	<meta name="viewport" content="width=device-width, initial-scale=1">
 	<link rel="stylesheet" href="../assets/css/main.css">
 </head>
@@ -22,7 +22,7 @@
 						<li class="state loading">Preparing search index...</li>
 						<li class="state failure">The search index is not available</li>
 					</ul>
-					<a href="../index.html" class="title">Compound.js - v0.1.1</a>
+					<a href="../index.html" class="title">Compound.js - v0.1.2</a>
 				</div>
 				<div class="table-cell" id="tsd-widgets">
 					<div id="tsd-filter">
@@ -92,15 +92,14 @@ <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/c06049c/src/api.ts#L60">api.ts:60</a></li>
+									<li>Defined in <a href="https://github.com/compound-finance/compound-js/blob/ecc1c42/src/api.ts#L64">api.ts:64</a></li>
 								</ul>
 							</aside>
 							<div class="tsd-comment tsd-typography">
 								<div class="lead">
 									<p>Makes a request to the AccountService API. The Account API retrieves
 										information for various accounts which have interacted with the protocol.
-										For more details, see the API documentation.
-									<a href="https://compound.finance/docs/api#AccountService">https://compound.finance/docs/api#AccountService</a></p>
+									For more details, see the Compound API documentation.</p>
 								</div>
 								<dl class="tsd-comment-tags">
 									<dt>example</dt>
@@ -150,14 +149,14 @@ <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/c06049c/src/api.ts#L85">api.ts:85</a></li>
+									<li>Defined in <a href="https://github.com/compound-finance/compound-js/blob/ecc1c42/src/api.ts#L89">api.ts:89</a></li>
 								</ul>
 							</aside>
 							<div class="tsd-comment tsd-typography">
 								<div class="lead">
 									<p>Makes a request to the CTokenService API. The cToken API retrieves
-										information about cToken contract interaction. Formore details, see the
-									API documentation. <a href="https://compound.finance/docs/api#CTokenService">https://compound.finance/docs/api#CTokenService</a></p>
+										information about cToken contract interaction. For more details, see the
+									Compound API documentation.</p>
 								</div>
 								<dl class="tsd-comment-tags">
 									<dt>example</dt>
@@ -195,14 +194,14 @@ <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/c06049c/src/api.ts#L141">api.ts:141</a></li>
+									<li>Defined in <a href="https://github.com/compound-finance/compound-js/blob/ecc1c42/src/api.ts#L145">api.ts:145</a></li>
 								</ul>
 							</aside>
 							<div class="tsd-comment tsd-typography">
 								<div class="lead">
 									<p>Makes a request to the GovernanceService API. The Governance Service includes
-										three endpoints to retrieve information about COMP accounts.
-									<a href="https://compound.finance/docs/api#GovernanceService">https://compound.finance/docs/api#GovernanceService</a></p>
+										three endpoints to retrieve information about COMP accounts. For more
+									details, see the Compound API documentation.</p>
 								</div>
 								<dl class="tsd-comment-tags">
 									<dt>example</dt>
@@ -248,14 +247,14 @@ <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/c06049c/src/api.ts#L113">api.ts:113</a></li>
+									<li>Defined in <a href="https://github.com/compound-finance/compound-js/blob/ecc1c42/src/api.ts#L117">api.ts:117</a></li>
 								</ul>
 							</aside>
 							<div class="tsd-comment tsd-typography">
 								<div class="lead">
 									<p>Makes a request to the MarketHistoryService API. The market history service
-										retrieves information about a market. For more details, see the API
-									documentation. <a href="https://compound.finance/docs/api#MarketHistoryService">https://compound.finance/docs/api#MarketHistoryService</a></p>
+										retrieves information about a market. For more details, see the Compound
+									API documentation.</p>
 								</div>
 								<dl class="tsd-comment-tags">
 									<dt>example</dt>

diff --git a/docs/modules/_comp_.html b/docs/modules/_comp_.html
@@ -3,8 +3,8 @@
 <head>
 	<meta charset="utf-8">
 	<meta http-equiv="X-UA-Compatible" content="IE=edge">
-	<title>&quot;comp&quot; | Compound.js - v0.1.1</title>
-	<meta name="description" content="Documentation for Compound.js - v0.1.1">
+	<title>&quot;comp&quot; | Compound.js - v0.1.2</title>
+	<meta name="description" content="Documentation for Compound.js - v0.1.2">
 	<meta name="viewport" content="width=device-width, initial-scale=1">
 	<link rel="stylesheet" href="../assets/css/main.css">
 </head>
@@ -22,7 +22,7 @@
 						<li class="state loading">Preparing search index...</li>
 						<li class="state failure">The search index is not available</li>
 					</ul>
-					<a href="../index.html" class="title">Compound.js - v0.1.1</a>
+					<a href="../index.html" class="title">Compound.js - v0.1.2</a>
 				</div>
 				<div class="table-cell" id="tsd-widgets">
 					<div id="tsd-filter">
@@ -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/c06049c/src/comp.ts#L150">comp.ts:150</a></li>
+									<li>Defined in <a href="https://github.com/compound-finance/compound-js/blob/ecc1c42/src/comp.ts#L156">comp.ts:156</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/c06049c/src/comp.ts#L330">comp.ts:330</a></li>
+									<li>Defined in <a href="https://github.com/compound-finance/compound-js/blob/ecc1c42/src/comp.ts#L336">comp.ts:336</a></li>
 								</ul>
 							</aside>
 							<div class="tsd-comment tsd-typography">
@@ -171,7 +171,7 @@ <h5><span class="tsd-flag ts-flagDefault value">Default value</span> expiry: <sp
 							</ul>
 							<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">&gt;</span></h4>
 							<p>Returns an object that contains the <code>v</code>, <code>r</code>, and <code>s</code>
-							components of an Ethereum signature as hexidecimal strings.</p>
+							components of an Ethereum signature as hexadecimal strings.</p>
 						</li>
 					</ul>
 				</section>
@@ -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/c06049c/src/comp.ts#L190">comp.ts:190</a></li>
+									<li>Defined in <a href="https://github.com/compound-finance/compound-js/blob/ecc1c42/src/comp.ts#L196">comp.ts:196</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/c06049c/src/comp.ts#L253">comp.ts:253</a></li>
+									<li>Defined in <a href="https://github.com/compound-finance/compound-js/blob/ecc1c42/src/comp.ts#L259">comp.ts:259</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/c06049c/src/comp.ts#L101">comp.ts:101</a></li>
+									<li>Defined in <a href="https://github.com/compound-finance/compound-js/blob/ecc1c42/src/comp.ts#L107">comp.ts:107</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/c06049c/src/comp.ts#L56">comp.ts:56</a></li>
+									<li>Defined in <a href="https://github.com/compound-finance/compound-js/blob/ecc1c42/src/comp.ts#L62">comp.ts:62</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/c06049c/src/comp.ts#L16">comp.ts:16</a></li>
+									<li>Defined in <a href="https://github.com/compound-finance/compound-js/blob/ecc1c42/src/comp.ts#L22">comp.ts:22</a></li>
 								</ul>
 							</aside>
 							<div class="tsd-comment tsd-typography">

diff --git a/docs/modules/_comptroller_.html b/docs/modules/_comptroller_.html
@@ -3,8 +3,8 @@
 <head>
 	<meta charset="utf-8">
 	<meta http-equiv="X-UA-Compatible" content="IE=edge">
-	<title>&quot;comptroller&quot; | Compound.js - v0.1.1</title>
-	<meta name="description" content="Documentation for Compound.js - v0.1.1">
+	<title>&quot;comptroller&quot; | Compound.js - v0.1.2</title>
+	<meta name="description" content="Documentation for Compound.js - v0.1.2">
 	<meta name="viewport" content="width=device-width, initial-scale=1">
 	<link rel="stylesheet" href="../assets/css/main.css">
 </head>
@@ -22,7 +22,7 @@
 						<li class="state loading">Preparing search index...</li>
 						<li class="state failure">The search index is not available</li>
 					</ul>
-					<a href="../index.html" class="title">Compound.js - v0.1.1</a>
+					<a href="../index.html" class="title">Compound.js - v0.1.2</a>
 				</div>
 				<div class="table-cell" id="tsd-widgets">
 					<div id="tsd-filter">
@@ -90,7 +90,7 @@ <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/c06049c/src/comptroller.ts#L26">comptroller.ts:26</a></li>
+									<li>Defined in <a href="https://github.com/compound-finance/compound-js/blob/ecc1c42/src/comptroller.ts#L32">comptroller.ts:32</a></li>
 								</ul>
 							</aside>
 							<div class="tsd-comment tsd-typography">
@@ -134,7 +134,7 @@ <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/c06049c/src/comptroller.ts#L83">comptroller.ts:83</a></li>
+									<li>Defined in <a href="https://github.com/compound-finance/compound-js/blob/ecc1c42/src/comptroller.ts#L86">comptroller.ts:86</a></li>
 								</ul>
 							</aside>
 							<div class="tsd-comment tsd-typography">
@@ -157,7 +157,7 @@ <h4 class="tsd-parameters-title">Parameters</h4>
 								<li>
 									<h5>market: <span class="tsd-signature-type">string</span></h5>
 									<div class="tsd-comment tsd-typography">
-										<p>An string of the market to exit.</p>
+										<p>A string of the symbol of the market to exit.</p>
 									</div>
 								</li>
 							</ul>

diff --git a/docs/modules/_constants_.html b/docs/modules/_constants_.html
@@ -3,8 +3,8 @@
 <head>
 	<meta charset="utf-8">
 	<meta http-equiv="X-UA-Compatible" content="IE=edge">
-	<title>&quot;constants&quot; | Compound.js - v0.1.1</title>
-	<meta name="description" content="Documentation for Compound.js - v0.1.1">
+	<title>&quot;constants&quot; | Compound.js - v0.1.2</title>
+	<meta name="description" content="Documentation for Compound.js - v0.1.2">
 	<meta name="viewport" content="width=device-width, initial-scale=1">
 	<link rel="stylesheet" href="../assets/css/main.css">
 </head>
@@ -22,7 +22,7 @@
 						<li class="state loading">Preparing search index...</li>
 						<li class="state failure">The search index is not available</li>
 					</ul>
-					<a href="../index.html" class="title">Compound.js - v0.1.1</a>
+					<a href="../index.html" class="title">Compound.js - v0.1.2</a>
 				</div>
 				<div class="table-cell" id="tsd-widgets">
 					<div id="tsd-filter">

diff --git a/docs/modules/_ctoken_.html b/docs/modules/_ctoken_.html
@@ -3,8 +3,8 @@
 <head>
 	<meta charset="utf-8">
 	<meta http-equiv="X-UA-Compatible" content="IE=edge">
-	<title>&quot;cToken&quot; | Compound.js - v0.1.1</title>
-	<meta name="description" content="Documentation for Compound.js - v0.1.1">
+	<title>&quot;cToken&quot; | Compound.js - v0.1.2</title>
+	<meta name="description" content="Documentation for Compound.js - v0.1.2">
 	<meta name="viewport" content="width=device-width, initial-scale=1">
 	<link rel="stylesheet" href="../assets/css/main.css">
 </head>
@@ -22,7 +22,7 @@
 						<li class="state loading">Preparing search index...</li>
 						<li class="state failure">The search index is not available</li>
 					</ul>
-					<a href="../index.html" class="title">Compound.js - v0.1.1</a>
+					<a href="../index.html" class="title">Compound.js - v0.1.2</a>
 				</div>
 				<div class="table-cell" id="tsd-widgets">
 					<div id="tsd-filter">
@@ -92,7 +92,7 @@ <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/c06049c/src/cToken.ts#L196">cToken.ts:196</a></li>
+									<li>Defined in <a href="https://github.com/compound-finance/compound-js/blob/ecc1c42/src/cToken.ts#L202">cToken.ts:202</a></li>
 								</ul>
 							</aside>
 							<div class="tsd-comment tsd-typography">
@@ -161,7 +161,7 @@ <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/c06049c/src/cToken.ts#L116">cToken.ts:116</a></li>
+									<li>Defined in <a href="https://github.com/compound-finance/compound-js/blob/ecc1c42/src/cToken.ts#L122">cToken.ts:122</a></li>
 								</ul>
 							</aside>
 							<div class="tsd-comment tsd-typography">
@@ -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/c06049c/src/cToken.ts#L264">cToken.ts:264</a></li>
+									<li>Defined in <a href="https://github.com/compound-finance/compound-js/blob/ecc1c42/src/cToken.ts#L270">cToken.ts:270</a></li>
 								</ul>
 							</aside>
 							<div class="tsd-comment tsd-typography">
@@ -293,7 +293,7 @@ <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/c06049c/src/cToken.ts#L37">cToken.ts:37</a></li>
+									<li>Defined in <a href="https://github.com/compound-finance/compound-js/blob/ecc1c42/src/cToken.ts#L43">cToken.ts:43</a></li>
 								</ul>
 							</aside>
 							<div class="tsd-comment tsd-typography">

diff --git a/docs/modules/_eip712_.html b/docs/modules/_eip712_.html
@@ -3,8 +3,8 @@
 <head>
 	<meta charset="utf-8">
 	<meta http-equiv="X-UA-Compatible" content="IE=edge">
-	<title>&quot;EIP712&quot; | Compound.js - v0.1.1</title>
-	<meta name="description" content="Documentation for Compound.js - v0.1.1">
+	<title>&quot;EIP712&quot; | Compound.js - v0.1.2</title>
+	<meta name="description" content="Documentation for Compound.js - v0.1.2">
 	<meta name="viewport" content="width=device-width, initial-scale=1">
 	<link rel="stylesheet" href="../assets/css/main.css">
 </head>
@@ -22,7 +22,7 @@
 						<li class="state loading">Preparing search index...</li>
 						<li class="state failure">The search index is not available</li>
 					</ul>
-					<a href="../index.html" class="title">Compound.js - v0.1.1</a>
+					<a href="../index.html" class="title">Compound.js - v0.1.2</a>
 				</div>
 				<div class="table-cell" id="tsd-widgets">
 					<div id="tsd-filter">