upgrade to latest docs-ts

gcanti · Dec 12, 2019 · c3d53fd · c3d53fd
1 parent 03aa922
commit c3d53fd
Show file tree

Hide file tree

Showing 9 changed files with 105 additions and 75 deletions.
diff --git a/docs/modules/PathReporter.ts.md b/docs/modules/PathReporter.ts.md
@@ -4,6 +4,10 @@ nav_order: 2
 parent: Modules
 ---
 
+# PathReporter overview
+
+Added in v1.0.0
+
 ---
 
 <h2 class="text-delta">Table of contents</h2>

diff --git a/docs/modules/Reporter.ts.md b/docs/modules/Reporter.ts.md
@@ -4,6 +4,10 @@ nav_order: 3
 parent: Modules
 ---
 
+# Reporter overview
+
+Added in v1.0.0
+
 ---
 
 <h2 class="text-delta">Table of contents</h2>

diff --git a/docs/modules/index.ts.md b/docs/modules/index.ts.md
@@ -4,6 +4,10 @@ nav_order: 1
 parent: Modules
 ---
 
+# index overview
+
+Added in v1.0.0
+
 ---
 
 <h2 class="text-delta">Table of contents</h2>

diff --git a/package-lock.json b/package-lock.json
diff --git a/package.json b/package.json
@@ -44,7 +44,7 @@
     "@types/jest": "^23.3.8",
     "@types/node": "7.0.4",
     "benchmark": "2.1.4",
-    "docs-ts": "^0.2.1",
+    "docs-ts": "^0.3.0",
     "doctoc": "^1.4.0",
     "dtslint": "github:gcanti/dtslint",
     "fp-ts": "^2.0.0",

diff --git a/src/PathReporter.ts b/src/PathReporter.ts
@@ -1,3 +1,6 @@
+/**
+ * @since 1.0.0
+ */
 import { Reporter } from './Reporter'
 import { Context, getFunctionName, ValidationError } from '.'
 import { fold } from 'fp-ts/lib/Either'

diff --git a/src/Reporter.ts b/src/Reporter.ts
@@ -1,3 +1,6 @@
+/**
+ * @since 1.0.0
+ */
 import { Validation } from './index'
 
 /**

diff --git a/src/ThrowReporter.ts b/src/ThrowReporter.ts
@@ -1,5 +1,6 @@
 /**
  * @deprecated
+ * @since 1.0.0
  */
 import { Reporter } from './Reporter'
 import { PathReporter } from './PathReporter'

diff --git a/src/index.ts b/src/index.ts
@@ -1,3 +1,6 @@
+/**
+ * @since 1.0.0
+ */
 import { Either, either, isLeft, left, right } from 'fp-ts/lib/Either'
 import { Predicate, Refinement } from 'fp-ts/lib/function'