Major effort on documentation

dtjohnson · Dec 22, 2019 · 3952646 · 3952646
1 parent 393a716
commit 3952646
Show file tree

Hide file tree

Showing 37 changed files with 1,862 additions and 1,200 deletions.
diff --git a/.eslintrc.json b/.eslintrc.json
@@ -278,7 +278,7 @@
         "object-shorthand": "warn",
         "prefer-arrow-callback": "warn",
         "prefer-const": "warn",
-        "prefer-destructuring": ["warn", { "object": true, "array": false } ],
+        "prefer-destructuring": "off", // Annoying
         "prefer-numeric-literals": "warn",
         "prefer-rest-params": "error",
         "prefer-spread": "error",

diff --git a/.vscode/launch.json b/.vscode/launch.json
@@ -32,6 +32,15 @@
         "windows": {
           "program": "${workspaceFolder}/node_modules/jest/bin/jest",
         }
+      },
+      {
+        "type": "node",
+        "request": "attach",
+        "name": "Attach",
+        "port": 9229,
+        "skipFiles": [
+          "<node_internals>/**"
+        ]
       }
     ]
   }
diff --git a/.vscode/settings.json b/.vscode/settings.json
@@ -9,5 +9,6 @@
     "typescript.tsdk": "node_modules/typescript/lib",
     "editor.codeActionsOnSave": {
         "source.fixAll.eslint": true
-    }
+    },
+    "debug.node.autoAttach": "on"
 }
diff --git a/README.md b/README.md
diff --git a/docs/assets/js/search.js b/docs/assets/js/search.js
diff --git a/docs/classes/assertionerror.html b/docs/classes/assertionerror.html
@@ -3,7 +3,7 @@
 <head>
 	<meta charset="utf-8">
 	<meta http-equiv="X-UA-Compatible" content="IE=edge">
-	<title>AssertionError | guardian</title>
+	<title>AssertionError | Guardian Documentation</title>
 	<meta name="description" content="">
 	<meta name="viewport" content="width=device-width, initial-scale=1">
 	<link rel="stylesheet" href="../assets/css/main.css">
@@ -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">guardian</a>
+					<a href="../index.html" class="title">Guardian Documentation</a>
 				</div>
 				<div class="table-cell" id="tsd-widgets">
 					<div id="tsd-filter">

diff --git a/docs/globals.html b/docs/globals.html
diff --git a/docs/index.html b/docs/index.html
diff --git a/docs/interfaces/comparable.html b/docs/interfaces/comparable.html
@@ -3,7 +3,7 @@
 <head>
 	<meta charset="utf-8">
 	<meta http-equiv="X-UA-Compatible" content="IE=edge">
-	<title>Comparable | guardian</title>
+	<title>Comparable | Guardian Documentation</title>
 	<meta name="description" content="">
 	<meta name="viewport" content="width=device-width, initial-scale=1">
 	<link rel="stylesheet" href="../assets/css/main.css">
@@ -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">guardian</a>
+					<a href="../index.html" class="title">Guardian Documentation</a>
 				</div>
 				<div class="table-cell" id="tsd-widgets">
 					<div id="tsd-filter">
@@ -106,7 +106,7 @@ <h3>compare<wbr>To</h3>
 						<li class="tsd-description">
 							<aside class="tsd-sources">
 								<ul>
-									<li>Defined in <a href="https://github.com/dtjohnson/guardian/blob/9025fbd/src/types.ts#L42">src/types.ts:42</a></li>
+									<li>Defined in <a href="https://github.com/dtjohnson/guardian/blob/393a716/src/types.ts#L42">src/types.ts:42</a></li>
 								</ul>
 							</aside>
 							<div class="tsd-comment tsd-typography">

diff --git a/docs/interfaces/emailbrand.html b/docs/interfaces/emailbrand.html
diff --git a/docs/interfaces/equatable.html b/docs/interfaces/equatable.html
@@ -3,7 +3,7 @@
 <head>
 	<meta charset="utf-8">
 	<meta http-equiv="X-UA-Compatible" content="IE=edge">
-	<title>Equatable | guardian</title>
+	<title>Equatable | Guardian Documentation</title>
 	<meta name="description" content="">
 	<meta name="viewport" content="width=device-width, initial-scale=1">
 	<link rel="stylesheet" href="../assets/css/main.css">
@@ -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">guardian</a>
+					<a href="../index.html" class="title">Guardian Documentation</a>
 				</div>
 				<div class="table-cell" id="tsd-widgets">
 					<div id="tsd-filter">
@@ -106,7 +106,7 @@ <h3>equals</h3>
 						<li class="tsd-description">
 							<aside class="tsd-sources">
 								<ul>
-									<li>Defined in <a href="https://github.com/dtjohnson/guardian/blob/9025fbd/src/types.ts#L30">src/types.ts:30</a></li>
+									<li>Defined in <a href="https://github.com/dtjohnson/guardian/blob/393a716/src/types.ts#L30">src/types.ts:30</a></li>
 								</ul>
 							</aside>
 							<div class="tsd-comment tsd-typography">

diff --git a/docs/interfaces/hasexpectation.html b/docs/interfaces/hasexpectation.html
@@ -3,7 +3,7 @@
 <head>
 	<meta charset="utf-8">
 	<meta http-equiv="X-UA-Compatible" content="IE=edge">
-	<title>HasExpectation | guardian</title>
+	<title>HasExpectation | Guardian Documentation</title>
 	<meta name="description" content="">
 	<meta name="viewport" content="width=device-width, initial-scale=1">
 	<link rel="stylesheet" href="../assets/css/main.css">
@@ -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">guardian</a>
+					<a href="../index.html" class="title">Guardian Documentation</a>
 				</div>
 				<div class="table-cell" id="tsd-widgets">
 					<div id="tsd-filter">
@@ -102,7 +102,7 @@ <h3><span class="tsd-flag ts-flagOptional">Optional</span> expectation</h3>
 					<div class="tsd-signature tsd-kind-icon">expectation<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span></div>
 					<aside class="tsd-sources">
 						<ul>
-							<li>Defined in <a href="https://github.com/dtjohnson/guardian/blob/9025fbd/src/types.ts#L8">src/types.ts:8</a></li>
+							<li>Defined in <a href="https://github.com/dtjohnson/guardian/blob/393a716/src/types.ts#L8">src/types.ts:8</a></li>
 						</ul>
 					</aside>
 					<div class="tsd-comment tsd-typography">