chore(docs): fix a few typos and issues in realSwipe docs

dmtrKovalenko · Feb 16, 2024 · 56d41d7 · 56d41d7
1 parent 7ba7806
commit 56d41d7
Show file tree

Hide file tree

Showing 2 changed files with 4 additions and 3 deletions.
diff --git a/README.md b/README.md
@@ -254,6 +254,7 @@ cy.realSwipe(direction, options);
 Options:
 
 - `Optional` **length**: undefined \| number **`default`** 10
+- `Optional` **step**: undefined \| number **`default`** 10
 - `Optional` **x**: undefined \| number ([more about coordinates](#coordinates))
 - `Optional` **y**: undefined \| number ([more about coordinates](#coordinates))
 - `Optional` **touchPosition**: "topLeft" | "top" | "topRight" | "left" | "center" | "right" | "bottomLeft" | "bottom" | "bottomRight"

diff --git a/src/commands/realSwipe.ts b/src/commands/realSwipe.ts
@@ -25,14 +25,14 @@ export interface RealSwipeOptions {
    */
   y?: number;
   /** Length of swipe (in pixels)
-   * @default 50
+   * @default 10
    * @example
    * cy.get(".drawer").realSwipe("toLeft", { length: 50 })
    */
   length?: number;
   /**
-   * Swipe step (how often new touch move will be generated). Less more precise
-   * ! Must be less than options.length
+   * Swipe step (how often new touch move will be generated).
+   * Must be less than or equal options.length
    * @default 10
    * cy.get(".drawer").realSwipe("toLeft", { step: 5 })
    */