effect 4.0.0-beta.71 → 4.0.0-beta.73

package/src/FiberMap.ts

@@ -608,7 +608,7 @@ export const set: {
 ): Effect.Effect<void> => Effect.sync(() => setUnsafe(self, key, fiber, options)))
 
 /**
- * Retrieve a fiber from the FiberMap.
+ * Retrieves a fiber from the FiberMap synchronously.
  *
  * **Example** (Retrieving a fiber unsafely)
  *
@@ -639,7 +639,7 @@ export const set: {
  */
 export const getUnsafe: {
   /**
-   * Retrieve a fiber from the FiberMap.
+   * Retrieves a fiber from the FiberMap synchronously.
    *
    * **Example** (Retrieving a fiber unsafely)
    *
@@ -670,7 +670,7 @@ export const getUnsafe: {
    */
   <K>(key: K): <A, E>(self: FiberMap<K, A, E>) => Option.Option<Fiber.Fiber<A, E>>
   /**
-   * Retrieve a fiber from the FiberMap.
+   * Retrieves a fiber from the FiberMap synchronously.
    *
    * **Example** (Retrieving a fiber unsafely)
    *
@@ -708,7 +708,7 @@ export const getUnsafe: {
 )
 
 /**
- * Retrieve a fiber from the FiberMap.
+ * Retrieves a fiber from the FiberMap effectfully.
  *
  * **Details**
  *
@@ -743,7 +743,7 @@ export const getUnsafe: {
  */
 export const get: {
   /**
-   * Retrieve a fiber from the FiberMap.
+   * Retrieves a fiber from the FiberMap effectfully.
    *
    * **Details**
    *
@@ -778,7 +778,7 @@ export const get: {
    */
   <K>(key: K): <A, E>(self: FiberMap<K, A, E>) => Effect.Effect<Option.Option<Fiber.Fiber<A, E>>>
   /**
-   * Retrieve a fiber from the FiberMap.
+   * Retrieves a fiber from the FiberMap effectfully.
    *
    * **Details**
    *
@@ -819,7 +819,7 @@ export const get: {
 )
 
 /**
- * Check if a key exists in the FiberMap.
+ * Checks whether a key exists in the FiberMap.
  *
  * **Example** (Checking if a key exists unsafely)
  *
@@ -843,7 +843,7 @@ export const get: {
  */
 export const hasUnsafe: {
   /**
-   * Check if a key exists in the FiberMap.
+   * Checks whether a key exists in the FiberMap.
    *
    * **Example** (Checking if a key exists unsafely)
    *
@@ -867,7 +867,7 @@ export const hasUnsafe: {
    */
   <K>(key: K): <A, E>(self: FiberMap<K, A, E>) => boolean
   /**
-   * Check if a key exists in the FiberMap.
+   * Checks whether a key exists in the FiberMap.
    *
    * **Example** (Checking if a key exists unsafely)
    *
@@ -897,7 +897,7 @@ export const hasUnsafe: {
 )
 
 /**
- * Check if a key exists in the FiberMap.
+ * Checks whether a key exists in the FiberMap.
  * This is the Effect-wrapped version of `hasUnsafe`.
  *
  * **Example** (Checking if a key exists)
@@ -925,7 +925,7 @@ export const hasUnsafe: {
  */
 export const has: {
   /**
-   * Check if a key exists in the FiberMap.
+   * Checks whether a key exists in the FiberMap.
    * This is the Effect-wrapped version of `hasUnsafe`.
    *
    * **Example** (Checking if a key exists)
@@ -953,7 +953,7 @@ export const has: {
    */
   <K>(key: K): <A, E>(self: FiberMap<K, A, E>) => Effect.Effect<boolean>
   /**
-   * Check if a key exists in the FiberMap.
+   * Checks whether a key exists in the FiberMap.
    * This is the Effect-wrapped version of `hasUnsafe`.
    *
    * **Example** (Checking if a key exists)
@@ -986,7 +986,7 @@ export const has: {
 )
 
 /**
- * Remove a fiber from the FiberMap, interrupting it if it exists.
+ * Removes a fiber from the FiberMap, interrupting it if it exists.
  *
  * **Example** (Removing a fiber)
  *
@@ -1014,7 +1014,7 @@ export const has: {
  */
 export const remove: {
   /**
-   * Remove a fiber from the FiberMap, interrupting it if it exists.
+   * Removes a fiber from the FiberMap, interrupting it if it exists.
    *
    * **Example** (Removing a fiber)
    *
@@ -1042,7 +1042,7 @@ export const remove: {
    */
   <K>(key: K): <A, E>(self: FiberMap<K, A, E>) => Effect.Effect<void>
   /**
-   * Remove a fiber from the FiberMap, interrupting it if it exists.
+   * Removes a fiber from the FiberMap, interrupting it if it exists.
    *
    * **Example** (Removing a fiber)
    *
@@ -1071,7 +1071,7 @@ export const remove: {
   <K, A, E>(self: FiberMap<K, A, E>, key: K): Effect.Effect<void>
 } = dual<
   /**
-   * Remove a fiber from the FiberMap, interrupting it if it exists.
+   * Removes a fiber from the FiberMap, interrupting it if it exists.
    *
    * **Example** (Removing a fiber)
    *
@@ -1099,7 +1099,7 @@ export const remove: {
    */
   <K>(key: K) => <A, E>(self: FiberMap<K, A, E>) => Effect.Effect<void>,
   /**
-   * Remove a fiber from the FiberMap, interrupting it if it exists.
+   * Removes a fiber from the FiberMap, interrupting it if it exists.
    *
    * **Example** (Removing a fiber)
    *
@@ -1139,7 +1139,7 @@ export const remove: {
   }))
 
 /**
- * Remove all fibers from the FiberMap, interrupting them.
+ * Removes all fibers from the FiberMap, interrupting them.
  *
  * **Example** (Clearing all fibers)
  *
@@ -1482,7 +1482,7 @@ export const runtimePromise = <K, A, E>(self: FiberMap<K, A, E>): <R = never>()
   )
 
 /**
- * Get the number of fibers currently in the FiberMap.
+ * Gets the number of fibers currently in the FiberMap.
  *
  * **Example** (Checking the map size)
  *
@@ -1539,7 +1539,7 @@ export const join = <K, A, E>(self: FiberMap<K, A, E>): Effect.Effect<void, E> =
   Deferred.await(self.deferred as Deferred.Deferred<void, E>)
 
 /**
- * Wait for the FiberMap to be empty.
+ * Waits for the FiberMap to be empty.
  * This will wait for all currently running fibers to complete.
  *
  * **Example** (Waiting for an empty map)

package/src/FiberSet.ts

@@ -93,7 +93,7 @@ export interface FiberSet<out A = unknown, out E = unknown>
 }
 
 /**
- * Checks if a value is a FiberSet.
+ * Checks whether a value is a FiberSet.
  *
  * **Example** (Checking if a value is a FiberSet)
  *
@@ -417,7 +417,7 @@ export const addUnsafe: {
 })
 
 /**
- * Add a fiber to the FiberSet. When the fiber completes, it will be removed.
+ * Adds a fiber to the FiberSet. When the fiber completes, it will be removed.
  *
  * **Example** (Adding a fiber)
  *
@@ -441,7 +441,7 @@ export const addUnsafe: {
  */
 export const add: {
   /**
-   * Add a fiber to the FiberSet. When the fiber completes, it will be removed.
+   * Adds a fiber to the FiberSet. When the fiber completes, it will be removed.
    *
    * **Example** (Adding a fiber)
    *
@@ -470,7 +470,7 @@ export const add: {
     } | undefined
   ): (self: FiberSet<A, E>) => Effect.Effect<void>
   /**
-   * Add a fiber to the FiberSet. When the fiber completes, it will be removed.
+   * Adds a fiber to the FiberSet. When the fiber completes, it will be removed.
    *
    * **Example** (Adding a fiber)
    *
@@ -511,7 +511,7 @@ export const add: {
 )
 
 /**
- * Interrupt all fibers in the FiberSet and clear the set.
+ * Interrupts all fibers in the `FiberSet` and clears the set.
  *
  * **Example** (Clearing all fibers)
  *
@@ -556,7 +556,7 @@ const constInterruptedFiber = (function() {
 })()
 
 /**
- * Fork an Effect and add the forked fiber to the FiberSet.
+ * Forks an Effect and add the forked fiber to the FiberSet.
  * When the fiber completes, it will be removed from the FiberSet.
  *
  * **Example** (Forking effects into a set)
@@ -584,7 +584,7 @@ const constInterruptedFiber = (function() {
  */
 export const run: {
   /**
-   * Fork an Effect and add the forked fiber to the FiberSet.
+   * Forks an Effect and add the forked fiber to the FiberSet.
    * When the fiber completes, it will be removed from the FiberSet.
    *
    * **Example** (Forking effects into a set)
@@ -620,7 +620,7 @@ export const run: {
     effect: Effect.Effect<XA, XE, R>
   ) => Effect.Effect<Fiber.Fiber<XA, XE>, never, R>
   /**
-   * Fork an Effect and add the forked fiber to the FiberSet.
+   * Forks an Effect and add the forked fiber to the FiberSet.
    * When the fiber completes, it will be removed from the FiberSet.
    *
    * **Example** (Forking effects into a set)
@@ -680,7 +680,7 @@ const runImpl = <A, E, R, XE extends E, XA extends A>(
   })
 
 /**
- * Capture a Runtime and use it to fork Effect's, adding the forked fibers to the FiberSet.
+ * Captures a `Runtime` and uses it to fork effects into the `FiberSet`.
  *
  * **Example** (Capturing a runtime)
  *
@@ -741,7 +741,13 @@ export const runtime: <A, E>(
   )
 
 /**
- * Captures a Runtime and uses it to fork Effects into the `FiberSet`.
+ * Captures a `Runtime` and returns a Promise-based runner that forks effects
+ * into the `FiberSet`.
+ *
+ * **When to use**
+ *
+ * Use when you need to bridge effects to `Promise` values while still tracking
+ * their fibers in a `FiberSet`.
  *
  * **Details**
  *
@@ -767,6 +773,8 @@ export const runtime: <A, E>(
  * })
  * ```
  *
+ * @see {@link runtime} for a runner that returns the forked `Fiber`
+ *
  * @category combinators
  * @since 3.13.0
  */
@@ -802,7 +810,7 @@ export const runtimePromise = <A, E>(self: FiberSet<A, E>): <R = never>() => Eff
   )
 
 /**
- * Get the number of fibers currently in the FiberSet.
+ * Gets the number of fibers currently in the FiberSet.
  *
  * **Example** (Checking the set size)
  *
@@ -829,7 +837,7 @@ export const size = <A, E>(self: FiberSet<A, E>): Effect.Effect<number> =>
   Effect.sync(() => self.state._tag === "Closed" ? 0 : self.state.backing.size)
 
 /**
- * Join all fibers in the FiberSet. If any of the Fiber's in the set terminate with a failure,
+ * Joins all fibers in the FiberSet. If any fiber in the set terminates with a failure,
  * the returned Effect will terminate with the first failure that occurred.
  *
  * **Example** (Joining failing fibers)
@@ -853,7 +861,7 @@ export const join = <A, E>(self: FiberSet<A, E>): Effect.Effect<void, E> =>
   Deferred.await(self.deferred as Deferred.Deferred<void, E>)
 
 /**
- * Wait until the fiber set is empty.
+ * Waits until the fiber set is empty.
  *
  * **Example** (Waiting for an empty set)
  *

package/src/FileSystem.ts

@@ -113,7 +113,7 @@ export interface FileSystem {
   readonly [TypeId]: typeof TypeId
 
   /**
-   * Check if a file can be accessed.
+   * Checks whether a file can be accessed.
    * You can optionally specify the level of access to check for.
    */
   readonly access: (
@@ -162,7 +162,7 @@ export interface FileSystem {
     gid: number
   ) => Effect.Effect<void, PlatformError>
   /**
-   * Check if a path exists.
+   * Checks whether a path exists.
    */
   readonly exists: (
     path: string
@@ -737,12 +737,16 @@ export type OpenFlag =
   | "ax+"
 
 /**
- * The service identifier for the FileSystem service.
+ * Service tag for platform file-system operations.
+ *
+ * **When to use**
+ *
+ * Use to access or provide operations for files, directories, permissions,
+ * streams, and sinks through the Effect context.
  *
  * **Details**
  *
  * This key is used to provide and access the FileSystem service in the Effect context.
- * Use this to inject file system implementations or access file system operations.
  *
  * **Example** (Accessing and providing FileSystem)
  *
@@ -774,7 +778,7 @@ export type OpenFlag =
  * )
  * ```
  *
- * @category tag
+ * @category tags
  * @since 4.0.0
  */
 export const FileSystem: Context.Service<FileSystem, FileSystem> = Context.Service("effect/platform/FileSystem")
@@ -1070,15 +1074,15 @@ export const layerNoop = (fileSystem: Partial<FileSystem>): Layer.Layer<FileSyst
  * Runtime type identifier attached to `FileSystem.File` handles and used by
  * `isFile` to recognize them.
  *
- * **When to use**
+ * **Details**
  *
- * Use when implementing a custom `FileSystem` file handle that should be
- * recognized by `isFile`.
+ * This marker is part of the runtime representation of file handles. Prefer
+ * `isFile` when narrowing unknown values.
  *
  * @see {@link File} for the open file handle shape that carries this marker
  * @see {@link isFile} for the public guard that checks this marker
  *
- * @category File
+ * @category type IDs
  * @since 4.0.0
  */
 export const FileTypeId = "~effect/platform/FileSystem/File"

package/src/Filter.ts

@@ -478,8 +478,8 @@ export const boolean: Filter<unknown, boolean> = fromPredicate(Predicate.isBoole
  *
  * **When to use**
  *
- * Use to keep `bigint` primitive values from unknown input while staying in the
- * composable `Filter` / `Result` pipeline.
+ * Use to keep primitive big integer values from unknown input while staying in
+ * the composable `Filter` / `Result` pipeline.
  *
  * **Details**
  *

package/src/Formatter.ts

@@ -99,7 +99,6 @@ export interface Formatter<in Value, out Format = string> {
  *
  * **Details**
  *
- * - Does not mutate input.
  * - Output is **not** valid JSON; use {@link formatJson} when you need
  *   parseable JSON.
  * - Primitives: stringified naturally (`null`, `undefined`, `123`, `true`).
@@ -285,7 +284,7 @@ function safeToString(input: any): string {
 }
 
 /**
- * Safely stringifies a value to JSON, silently dropping circular references.
+ * Stringifies a value to JSON safely, silently dropping circular references.
  *
  * **When to use**
  *
@@ -295,7 +294,6 @@ function safeToString(input: any): string {
  *
  * **Details**
  *
- * - Does not mutate input.
  * - Uses `JSON.stringify` internally with a replacer that tracks the
  *   current object ancestry.
  * - Circular references are replaced with `undefined` (omitted from

package/src/Function.ts

@@ -313,7 +313,7 @@ export const dual: {
   }
 }
 /**
- * Apply a function to a given value.
+ * Applies a function to a given value.
  *
  * **When to use**
  *
@@ -384,7 +384,7 @@ export type LazyArg<A> = () => A
 export type FunctionN<A extends ReadonlyArray<unknown>, B> = (...args: A) => B
 
 /**
- * The identity function, i.e. A function that returns its input argument.
+ * Returns its input argument unchanged.
  *
  * **When to use**
  *
@@ -405,7 +405,7 @@ export type FunctionN<A extends ReadonlyArray<unknown>, B> = (...args: A) => B
 export const identity = <A>(a: A): A => a
 
 /**
- * A function that ensures that the type of an expression matches some type,
+ * Ensures that the type of an expression matches some type,
  * without changing the resulting type of that expression.
  *
  * **When to use**
@@ -481,7 +481,7 @@ export const cast: <A, B>(a: A) => B = identity as any
 export const constant = <A>(value: A): LazyArg<A> => () => value
 
 /**
- * A thunk that returns always `true`.
+ * Returns `true` when called.
  *
  * **When to use**
  *
@@ -502,7 +502,7 @@ export const constant = <A>(value: A): LazyArg<A> => () => value
 export const constTrue: LazyArg<boolean> = constant(true)
 
 /**
- * A thunk that returns always `false`.
+ * Returns `false` when called.
  *
  * **When to use**
  *
@@ -523,7 +523,7 @@ export const constTrue: LazyArg<boolean> = constant(true)
 export const constFalse: LazyArg<boolean> = constant(false)
 
 /**
- * A thunk that returns always `null`.
+ * Returns `null` when called.
  *
  * **When to use**
  *
@@ -544,7 +544,7 @@ export const constFalse: LazyArg<boolean> = constant(false)
 export const constNull: LazyArg<null> = constant(null)
 
 /**
- * A thunk that returns always `undefined`.
+ * Returns `undefined` when called.
  *
  * **When to use**
  *
@@ -566,7 +566,7 @@ export const constNull: LazyArg<null> = constant(null)
 export const constUndefined: LazyArg<undefined> = constant(undefined)
 
 /**
- * A thunk that returns always `void`.
+ * Returns no meaningful value when called.
  *
  * **When to use**
  *
@@ -755,7 +755,7 @@ export const absurd = <A>(_: never): A => {
 export const tupled = <A extends ReadonlyArray<unknown>, B>(f: (...a: A) => B): (a: A) => B => (a) => f(...a)
 
 /**
- * Inverse function of `tupled`
+ * Converts a tupled function back to an uncurried function.
  *
  * **When to use**
  *
@@ -1567,7 +1567,7 @@ export function flow(
 export const hole: <T>() => T = cast(absurd)
 
 /**
- * The SK combinator, also known as the "S-K combinator" or "S-combinator", is
+ * Returns the second argument and discards the first. The SK combinator is
  * a fundamental combinator in the lambda calculus and the SKI combinator
  * calculus.
  *
@@ -1590,8 +1590,8 @@ export const hole: <T>() => T = cast(absurd)
 export const SK = <A, B>(_: A, b: B): B => b
 
 /**
- * Memoizes a function whose input is an object, caching results by object
- * identity.
+ * Creates a memoized function whose input is an object, caching results by
+ * object identity.
  *
  * **When to use**
  *

package/src/Graph.ts

@@ -115,7 +115,7 @@ export type NodeIndex = number
 export type EdgeIndex = number
 
 /**
- * Edge data containing source, target, and user data.
+ * Represents edge data containing source, target, and user data.
  *
  * **When to use**
  *
@@ -722,7 +722,7 @@ export const addNode = <N, E, T extends Kind = "directed">(
 }
 
 /**
- * Gets the data associated with a node index, if it exists.
+ * Gets the data associated with a node index safely, if it exists.
  *
  * **Example** (Getting node data)
  *
@@ -746,7 +746,7 @@ export const addNode = <N, E, T extends Kind = "directed">(
  */
 export const getNode: {
   /**
-   * Gets the data associated with a node index, if it exists.
+   * Gets the data associated with a node index safely, if it exists.
    *
    * **Example** (Getting node data)
    *
@@ -770,7 +770,7 @@ export const getNode: {
    */
   <N, E, T extends Kind = "directed">(nodeIndex: NodeIndex): (graph: Graph<N, E, T> | MutableGraph<N, E, T>) => Option.Option<N>
   /**
-   * Gets the data associated with a node index, if it exists.
+   * Gets the data associated with a node index safely, if it exists.
    *
    * **Example** (Getting node data)
    *
@@ -799,7 +799,7 @@ export const getNode: {
 ): Option.Option<N> => graph.nodes.has(nodeIndex) ? Option.some(graph.nodes.get(nodeIndex)!) : Option.none())
 
 /**
- * Checks if a node with the given index exists in the graph.
+ * Checks whether a node with the given index exists in the graph.
  *
  * **Example** (Checking node existence)
  *
@@ -824,7 +824,7 @@ export const getNode: {
  */
 export const hasNode: {
   /**
-   * Checks if a node with the given index exists in the graph.
+   * Checks whether a node with the given index exists in the graph.
    *
    * **Example** (Checking node existence)
    *
@@ -849,7 +849,7 @@ export const hasNode: {
    */
   (nodeIndex: NodeIndex): <N, E, T extends Kind = "directed">(graph: Graph<N, E, T> | MutableGraph<N, E, T>) => boolean
   /**
-   * Checks if a node with the given index exists in the graph.
+   * Checks whether a node with the given index exists in the graph.
    *
    * **Example** (Checking node existence)
    *
@@ -1430,7 +1430,7 @@ export const mapEdges = <N, E, T extends Kind = "directed">(
 }
 
 /**
- * Reverses all edge directions in a mutable graph by swapping source and target nodes.
+ * Swaps source and target nodes for every edge in a mutable graph.
  *
  * **Example** (Reversing edge directions)
  *
@@ -1971,7 +1971,7 @@ const removeEdgeInternal = <N, E, T extends Kind = "directed">(
 // =============================================================================
 
 /**
- * Gets the edge data associated with an edge index, if it exists.
+ * Gets the edge data associated with an edge index safely, if it exists.
  *
  * **Example** (Getting edge data)
  *
@@ -2003,7 +2003,7 @@ export const getEdge: {
   // =============================================================================
 
   /**
-   * Gets the edge data associated with an edge index, if it exists.
+   * Gets the edge data associated with an edge index safely, if it exists.
    *
    * **Example** (Getting edge data)
    *
@@ -2035,7 +2035,7 @@ export const getEdge: {
   // =============================================================================
 
   /**
-   * Gets the edge data associated with an edge index, if it exists.
+   * Gets the edge data associated with an edge index safely, if it exists.
    *
    * **Example** (Getting edge data)
    *
@@ -2068,7 +2068,7 @@ export const getEdge: {
 ): Option.Option<Edge<E>> => Option.fromUndefinedOr(graph.edges.get(edgeIndex)))
 
 /**
- * Checks if an edge exists between two nodes in the graph.
+ * Checks whether an edge exists between two nodes in the graph.
  *
  * **Example** (Checking edge existence)
  *
@@ -2098,7 +2098,7 @@ export const getEdge: {
  */
 export const hasEdge: {
   /**
-   * Checks if an edge exists between two nodes in the graph.
+   * Checks whether an edge exists between two nodes in the graph.
    *
    * **Example** (Checking edge existence)
    *
@@ -2128,7 +2128,7 @@ export const hasEdge: {
    */
   (source: NodeIndex, target: NodeIndex): <N, E, T extends Kind = "directed">(graph: Graph<N, E, T> | MutableGraph<N, E, T>) => boolean
   /**
-   * Checks if an edge exists between two nodes in the graph.
+   * Checks whether an edge exists between two nodes in the graph.
    *
    * **Example** (Checking edge existence)
    *
@@ -2346,7 +2346,7 @@ export const neighbors: {
 })
 
 /**
- * Get neighbors of a node in a specific direction for bidirectional traversal.
+ * Gets neighbors of a node in a specific direction for bidirectional traversal.
  *
  * **Example** (Traversing directed neighbors)
  *
@@ -2374,7 +2374,7 @@ export const neighbors: {
  */
 export const neighborsDirected: {
   /**
-   * Get neighbors of a node in a specific direction for bidirectional traversal.
+   * Gets neighbors of a node in a specific direction for bidirectional traversal.
    *
    * **Example** (Traversing directed neighbors)
    *
@@ -2402,7 +2402,7 @@ export const neighborsDirected: {
    */
   (nodeIndex: NodeIndex, direction: Direction): <N, E, T extends Kind = "directed">(graph: Graph<N, E, T> | MutableGraph<N, E, T>) => Array<NodeIndex>
   /**
-   * Get neighbors of a node in a specific direction for bidirectional traversal.
+   * Gets neighbors of a node in a specific direction for bidirectional traversal.
    *
    * **Example** (Traversing directed neighbors)
    *
@@ -3535,7 +3535,7 @@ export type Direction = "outgoing" | "incoming"
 // =============================================================================
 
 /**
- * Checks if the graph is acyclic (contains no cycles).
+ * Checks whether the graph is acyclic (contains no cycles).
  *
  * **Details**
  *
@@ -3648,7 +3648,7 @@ export const isAcyclic = <N, E, T extends Kind = "directed">(
 }
 
 /**
- * Checks if an undirected graph is bipartite.
+ * Checks whether an undirected graph is bipartite.
  *
  * **Details**
  *
@@ -3763,7 +3763,7 @@ const getUndirectedNeighbors = <N, E>(
 }
 
 /**
- * Find connected components in an undirected graph.
+ * Finds connected components in an undirected graph.
  * Each component is represented as an array of node indices.
  *
  * **Example** (Finding connected components)
@@ -3822,7 +3822,7 @@ export const connectedComponents = <N, E>(
 }
 
 /**
- * Find strongly connected components in a directed graph using Kosaraju's algorithm.
+ * Finds strongly connected components in a directed graph using Kosaraju's algorithm.
  * Each SCC is represented as an array of node indices.
  *
  * **Example** (Finding strongly connected components)
@@ -5089,7 +5089,7 @@ export const bellmanFord: {
 })
 
 /**
- * Iterable wrapper used by graph traversal and listing APIs.
+ * Represents an iterable wrapper used by graph traversal and listing APIs.
  *
  * **Details**
  *