Add doc comments to shiftBy

NASA-AMMOS · Jun 28, 2023 · 5c612d8 · 5c612d8
1 parent 3ff3ad4
commit 5c612d8
Showing 1 changed file with 20 additions and 0 deletions.
diff --git a/merlin-server/constraints-dsl-compiler/src/libs/constraints-edsl-fluent-api.ts b/merlin-server/constraints-dsl-compiler/src/libs/constraints-edsl-fluent-api.ts
@@ -699,6 +699,11 @@ export class Real {
     });
   }
 
+  /**
+   * Shifts the profile forward or backward in time.
+   *
+   * @param duration duration shift each segment (can be negative)
+   */
   public shiftBy(duration: Temporal.Duration): Real {
     return new Real({
       kind: AST.NodeKind.ProfileExpressionShiftBy,
@@ -868,6 +873,11 @@ export class Discrete<Schema> {
     });
   }
 
+  /**
+   * Shifts the profile forward or backward in time.
+   *
+   * @param duration duration shift each segment (can be negative)
+   */
   public shiftBy(duration: Temporal.Duration): Discrete<Schema> {
     return new Discrete<Schema>({
       kind: AST.NodeKind.ProfileExpressionShiftBy,
@@ -1336,6 +1346,11 @@ declare global {
      */
     public valueAt(timepoint: Spans): Discrete<number>;
 
+    /**
+     * Shifts the profile forward or backward in time.
+     *
+     * @param duration duration shift each segment (can be negative)
+     */
     public shiftBy(duration: Temporal.Duration): Real;
   }
 
@@ -1426,6 +1441,11 @@ declare global {
      */
     public valueAt(timepoint: Spans): Discrete<Schema>;
 
+    /**
+     * Shifts the profile forward or backward in time.
+     *
+     * @param duration duration shift each segment (can be negative)
+     */
     public shiftBy(duration: Temporal.Duration): Discrete<Schema>;
   }