Fix docs for timeseries functions

leak4mk0 · May 31, 2018 · 52bbf4a · 52bbf4a
1 parent e807410
commit 52bbf4a
Show file tree

Hide file tree

Showing 6 changed files with 122 additions and 128 deletions.
diff --git a/packages/pond/lib/timeseries.d.ts b/packages/pond/lib/timeseries.d.ts
@@ -679,7 +679,7 @@ export declare class TimeSeries<T extends Key> {
      * ```
      * Options:
      *  * `fieldSpec` - the field to fill
-     *  * `method` - the interpolation method, one of `FillMethod.Hold`, `FillMethod.Pad`
+     *  * `method` - the interpolation method, one of `FillMethod.Zero`, `FillMethod.Pad`
      *               or `FillMethod.Linear`
      *  * `limit` - the number of missing values to fill before giving up
      *
@@ -760,7 +760,7 @@ export declare class TimeSeries<T extends Key> {
      *     const timeseries = new TimeSeries(data);
      *     const dailyAvg = timeseries.fixedWindowRollup({
      *         windowSize: "1d",
-     *         aggregation: {value: {value: avg()}}
+     *         aggregation: {value:["value", avg()]}
      *     });
      * ```
      *
@@ -779,7 +779,7 @@ export declare class TimeSeries<T extends Key> {
      * applied. This specification describes a mapping of output
      * fieldNames to aggregation functions and their fieldPath. For example:
      * ```
-     * {in_avg: {in: avg()}, out_avg: {out: avg()}}
+     * {in_avg: ["in", avg()], out_avg: ["out", avg()]}
      * ```
      *
      */
@@ -791,7 +791,7 @@ export declare class TimeSeries<T extends Key> {
      * applied. This specification describes a mapping of output
      * fieldNames to aggregation functions and their fieldPath. For example:
      * ```
-     * {in_avg: {in: avg()}, out_avg: {out: avg()}}
+     * {in_avg: ["in", avg()], out_avg: ["out", avg()]}
      * ```
      *
      */
@@ -803,7 +803,7 @@ export declare class TimeSeries<T extends Key> {
      * applied. This specification describes a mapping of output
      * fieldNames to aggregation functions and their fieldPath. For example:
      * ```
-     * {in_avg: {in: avg()}, out_avg: {out: avg()}}
+     * {in_avg: ["in", avg()], out_avg: ["out", avg()]}
      * ```
      *
      */
@@ -815,7 +815,7 @@ export declare class TimeSeries<T extends Key> {
      * fieldNames to aggregation functions and their fieldPath. For example:
      *
      * ```
-     * {in_avg: {in: avg()}, out_avg: {out: avg()}}
+     * {in_avg: ["in", avg()], out_avg: ["out", avg()]}
      * ```
      *
      */

diff --git a/packages/pond/lib/timeseries.js b/packages/pond/lib/timeseries.js
diff --git a/packages/pond/lib/types.d.ts b/packages/pond/lib/types.d.ts
@@ -49,7 +49,7 @@ export declare enum AlignmentMethod {
 }
 /**
  * Method of filling used by the `fill()` function:
- *  * `Hold` - Fill with the previous value
+ *  * `Pad` - Fill with the previous value
  *  * `Linear` - Fill between the last value and the next value linearly
  *  * `Zero` - Fill with 0
  */

diff --git a/packages/pond/lib/types.js b/packages/pond/lib/types.js
diff --git a/packages/pond/src/timeseries.ts b/packages/pond/src/timeseries.ts
@@ -1154,7 +1154,7 @@ export class TimeSeries<T extends Key> {
      *     const timeseries = new TimeSeries(data);
      *     const dailyAvg = timeseries.fixedWindowRollup({
      *         windowSize: "1d",
-     *         aggregation: {value: {value: avg()}}
+     *         aggregation: {value:["value", avg()]}
      *     });
      * ```
      *
@@ -1193,7 +1193,7 @@ export class TimeSeries<T extends Key> {
      * applied. This specification describes a mapping of output
      * fieldNames to aggregation functions and their fieldPath. For example:
      * ```
-     * {in_avg: {in: avg()}, out_avg: {out: avg()}}
+     * {in_avg: ["in", avg()], out_avg: ["out", avg()]}
      * ```
      *
      */
@@ -1219,7 +1219,7 @@ export class TimeSeries<T extends Key> {
      * applied. This specification describes a mapping of output
      * fieldNames to aggregation functions and their fieldPath. For example:
      * ```
-     * {in_avg: {in: avg()}, out_avg: {out: avg()}}
+     * {in_avg: ["in", avg()], out_avg: ["out", avg()]}
      * ```
      *
      */
@@ -1240,7 +1240,7 @@ export class TimeSeries<T extends Key> {
      * applied. This specification describes a mapping of output
      * fieldNames to aggregation functions and their fieldPath. For example:
      * ```
-     * {in_avg: {in: avg()}, out_avg: {out: avg()}}
+     * {in_avg: ["in", avg()], out_avg: ["out", avg()]}
      * ```
      *
      */
@@ -1266,7 +1266,7 @@ export class TimeSeries<T extends Key> {
      * fieldNames to aggregation functions and their fieldPath. For example:
      *
      * ```
-     * {in_avg: {in: avg()}, out_avg: {out: avg()}}
+     * {in_avg: ["in", avg()], out_avg: ["out", avg()]}
      * ```
      *
      */