docs: fix flat args ordering (#265)

marpple · Apr 14, 2024 · 59e6a87 · 59e6a87
1 parent 3f86e1b
commit 59e6a87
Show file tree

Hide file tree

Showing 2 changed files with 13 additions and 3 deletions.
diff --git a/src/Lazy/flat.ts b/src/Lazy/flat.ts
@@ -203,7 +203,7 @@ function async<A>(
 
 /**
  * Returns flattened Iterable/AsyncIterable.
- * If first argument is number, more perform flatten `flat(2, [[[1,2]]]) // [1,2]`
+ * If first argument is number, more perform flatten `flat([[[1,2]]], 2) // [1,2]`
  *
  * @example
  * ```ts

diff --git a/src/Lazy/fx.ts b/src/Lazy/fx.ts
@@ -60,7 +60,14 @@ class FxAsyncIterable<A> {
 
   /**
    * Returns flattened AsyncIterable.
-   * If first argument is number, more perform flatten `flat(2, [[[1,2]]]) // [1,2]`
+   * If first argument is number, more perform flatten
+   *
+   * @example
+   * ```
+   * await fx([[1],[[2]]])
+   *   .toAsync()
+   *   .flat(2).toArray(); // [1,2]
+   * ```
    *
    * see {@link https://fxts.dev/docs/flat | flat}
    */
@@ -312,7 +319,10 @@ export class FxIterable<A> {
 
   /**
    * Returns flattened Iterable.
-   * If first argument is number, more perform flatten `flat(2, [[[1,2]]]) // [1,2]`
+   * If first argument is number, more perform flatten
+   *
+   * @example
+   * `fx([[1],[[2]]]).flat(2).toArray(); // [1,2]`
    *
    * see {@link https://fxts.dev/docs/flat | flat}
    */