chore(:book:): dont point TypeDoc at test suite

AFFECTS PACKAGES: @esri/arcgis-rest-items ISSUES CLOSED: #347
Esri · Oct 8, 2018 · 532cc33 · 532cc33
1 parent b0c81c6
commit 532cc33
Show file tree

Hide file tree

Showing 4 changed files with 63 additions and 56 deletions.
diff --git a/docs/build-typedoc.js b/docs/build-typedoc.js
@@ -1,5 +1,5 @@
 const spawn = require("cross-spawn");
-const { join, resolve } = require("path");
+const { join } = require("path");
 const { readFile, writeFile } = require("fs");
 const _ = require("lodash");
 const OUTPUT = join(process.cwd(), "docs", "src", `typedoc.json`);
@@ -17,6 +17,8 @@ const md = new MarkdownIt();
       [
         "-json",
         OUTPUT,
+        "--exclude",
+        "**/*test.ts",
         "--ignoreCompilerErrors",
         "--module",
         "common",

diff --git a/package-lock.json b/package-lock.json
diff --git a/package.json b/package.json
@@ -57,7 +57,7 @@
     "tslint": "^5.8.0",
     "tslint-config-prettier": "^1.6.0",
     "tslint-config-standard": "^6.0.1",
-    "typedoc": "^0.8.0",
+    "typedoc": "^0.12.0",
     "typescript": "^3.0.0"
   },
   "dependencies": {

diff --git a/packages/arcgis-rest-items/src/update.ts b/packages/arcgis-rest-items/src/update.ts
@@ -31,9 +31,9 @@ export interface IItemMoveRequestOptions extends IItemCrudRequestOptions {
 }
 
 /**
- * Update an Item
+ * Update an Item. See the [REST Documentation](https://developers.arcgis.com/rest/users-groups-and-items/update-item.htm) for more information.
  *
- * * ```js
+ * ```js
  * import { updateItem } from '@esri/arcgis-rest-items';
  *
  * updateItem({