docs(intervals): fix readme code example

thi-ng · Jan 24, 2020 · acfa908 · acfa908
1 parent 5813afc
commit acfa908
Show file tree

Hide file tree

Showing 2 changed files with 30 additions and 18 deletions.
diff --git a/packages/intervals/README.md b/packages/intervals/README.md
@@ -45,17 +45,17 @@ Package sizes (gzipped): ESM: 1.4KB / CJS: 1.5KB / UMD: 1.5KB
 
 ## Dependencies
 
-- [@thi.ng/api](https://github.com/thi-ng/umbrella/tree/master/packages/api)
-- [@thi.ng/checks](https://github.com/thi-ng/umbrella/tree/master/packages/checks)
-- [@thi.ng/dlogic](https://github.com/thi-ng/umbrella/tree/master/packages/dlogic)
-- [@thi.ng/errors](https://github.com/thi-ng/umbrella/tree/master/packages/errors)
+- [@thi.ng/api](https://github.com/thi-ng/umbrella/tree/develop/packages/api)
+- [@thi.ng/checks](https://github.com/thi-ng/umbrella/tree/develop/packages/checks)
+- [@thi.ng/dlogic](https://github.com/thi-ng/umbrella/tree/develop/packages/dlogic)
+- [@thi.ng/errors](https://github.com/thi-ng/umbrella/tree/develop/packages/errors)
 
 ## API
 
 [Generated API docs](https://docs.thi.ng/umbrella/intervals/)
 
 ```ts
-import { Interval } from "@thi.ng/intervals";
+import { interval, Interval } from "@thi.ng/intervals";
 
 // [0 .. +∞] (fully closed)
 a = Interval.withMin(0);
@@ -68,7 +68,7 @@ i.toString();
 // [0 .. 1)
 
 // parse from string
-Interval.parse("[0 .. 1)")
+interval("[0 .. 1)")
 // Interval { l: 0, r: 1, lopen: false, ropen: true }
 
 i.contains(1);
@@ -77,14 +77,20 @@ i.contains(1);
 i.contains(0.999999);
 // true
 
-// classify point (true if x < LHS)
+// classify interval relative to point (true if RHS < x)
 i.isBefore(-1)
+// false
+
+i.isBefore(1)
 // true
 
-// classify point (true if x > RHS)
-i.isAfter(1);
+// classify interval relative to point (true if LHS > x)
+i.isAfter(-1);
 // true
 
+i.isAfter(1);
+// false
+
 // grow interval to include 2 => [0 ... 2]
 i2 = i.include(2);
 
@@ -94,11 +100,11 @@ i.compare(i2);
 
 // classify WRT given interval arg
 i.classify(Interval.infinity());
-// Classifier.SUBSET
+// 3 (aka Classifier.SUBSET)
 
 // create transformed interval
 // (here scaled around centroid)
-i.map((x) => x + (x - i.centroid()) * 2);
+i.map((x) => x + (x - i.centroid()) * 2).toString();
 // [-1 .. 2)
 
 // iterator of decimated interval values

diff --git a/packages/intervals/README.tpl.md b/packages/intervals/README.tpl.md
@@ -48,7 +48,7 @@ ${examples}
 ${docLink}
 
 ```ts
-import { Interval } from "@thi.ng/intervals";
+import { interval, Interval } from "@thi.ng/intervals";
 
 // [0 .. +∞] (fully closed)
 a = Interval.withMin(0);
@@ -61,7 +61,7 @@ i.toString();
 // [0 .. 1)
 
 // parse from string
-Interval.parse("[0 .. 1)")
+interval("[0 .. 1)")
 // Interval { l: 0, r: 1, lopen: false, ropen: true }
 
 i.contains(1);
@@ -70,14 +70,20 @@ i.contains(1);
 i.contains(0.999999);
 // true
 
-// classify point (true if x < LHS)
+// classify interval relative to point (true if RHS < x)
 i.isBefore(-1)
+// false
+
+i.isBefore(1)
 // true
 
-// classify point (true if x > RHS)
-i.isAfter(1);
+// classify interval relative to point (true if LHS > x)
+i.isAfter(-1);
 // true
 
+i.isAfter(1);
+// false
+
 // grow interval to include 2 => [0 ... 2]
 i2 = i.include(2);
 
@@ -87,11 +93,11 @@ i.compare(i2);
 
 // classify WRT given interval arg
 i.classify(Interval.infinity());
-// Classifier.SUBSET
+// 3 (aka Classifier.SUBSET)
 
 // create transformed interval
 // (here scaled around centroid)
-i.map((x) => x + (x - i.centroid()) * 2);
+i.map((x) => x + (x - i.centroid()) * 2).toString();
 // [-1 .. 2)
 
 // iterator of decimated interval values