Fix CreateIteratorContext n documentation (#244)

nevware21 · Feb 15, 2024 · 8f43a94 · 8f43a94
1 parent 7cc0dbe
commit 8f43a94
Show file tree

Hide file tree

Showing 6 changed files with 20 additions and 17 deletions.
diff --git a/docs/typedoc/assets/main.js b/docs/typedoc/assets/main.js
diff --git a/docs/typedoc/functions/createIterable.html b/docs/typedoc/functions/createIterable.html
diff --git a/docs/typedoc/functions/createIterator.html b/docs/typedoc/functions/createIterator.html
diff --git a/docs/typedoc/functions/makeIterable.html b/docs/typedoc/functions/makeIterable.html
diff --git a/docs/typedoc/interfaces/CreateIteratorContext.html b/docs/typedoc/interfaces/CreateIteratorContext.html
diff --git a/lib/src/iterator/create.ts b/lib/src/iterator/create.ts
@@ -20,9 +20,10 @@ import { WellKnownSymbols } from "../symbol/well_known";
 export interface CreateIteratorContext<T> {
     /**
      * A function that returns a boolean to indicate whether it was able to produce
-     * the next value in the sequence.
+     * the next value in the sequence. It should return `true` when the sequence is done.
      * @param args - Optional additional arguments that where passed to the iterator `next` function.
-     * @return `true` if a new value was produced and assigned to the `v` of the context, otherwise `false`
+     * @return `false` if a new value was produced and assigned to the `v` of the context, otherwise
+     * `true` to indicate that the sequence is done.
      */
     n: (...args: any) => boolean;