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

package/src/TxHashSet.ts

@@ -283,7 +283,7 @@ export const fromHashSet = <V>(hashSet: HashSet.HashSet<V>): Effect.Effect<TxHas
   })
 
 /**
- * Checks if a value is a TxHashSet.
+ * Checks whether a value is a TxHashSet.
  *
  * **Example** (Checking for a TxHashSet)
  *
@@ -617,7 +617,7 @@ export const remove: {
   }).pipe(Effect.tx))
 
 /**
- * Checks if the TxHashSet contains the specified value.
+ * Checks whether the TxHashSet contains the specified value.
  *
  * **Example** (Checking membership)
  *
@@ -653,7 +653,7 @@ export const remove: {
  */
 export const has: {
   /**
-   * Checks if the TxHashSet contains the specified value.
+   * Checks whether the TxHashSet contains the specified value.
    *
    * **Example** (Checking membership)
    *
@@ -689,7 +689,7 @@ export const has: {
    */
   <V>(value: V): (self: TxHashSet<V>) => Effect.Effect<boolean>
   /**
-   * Checks if the TxHashSet contains the specified value.
+   * Checks whether the TxHashSet contains the specified value.
    *
    * **Example** (Checking membership)
    *
@@ -726,7 +726,7 @@ export const has: {
   <V>(self: TxHashSet<V>, value: V): Effect.Effect<boolean>
 } = dual<
   /**
-   * Checks if the TxHashSet contains the specified value.
+   * Checks whether the TxHashSet contains the specified value.
    *
    * **Example** (Checking membership)
    *
@@ -762,7 +762,7 @@ export const has: {
    */
   <V>(value: V) => (self: TxHashSet<V>) => Effect.Effect<boolean>,
   /**
-   * Checks if the TxHashSet contains the specified value.
+   * Checks whether the TxHashSet contains the specified value.
    *
    * **Example** (Checking membership)
    *
@@ -833,7 +833,7 @@ export const size = <V>(self: TxHashSet<V>): Effect.Effect<number> =>
   })
 
 /**
- * Checks if the TxHashSet is empty.
+ * Checks whether the TxHashSet is empty.
  *
  * **Example** (Checking whether a set is empty)
  *
@@ -1258,7 +1258,7 @@ export const difference: {
   }).pipe(Effect.tx))
 
 /**
- * Checks if a TxHashSet is a subset of another TxHashSet.
+ * Checks whether a TxHashSet is a subset of another TxHashSet.
  *
  * **Example** (Checking subset relationships)
  *
@@ -1282,7 +1282,7 @@ export const difference: {
  */
 export const isSubset: {
   /**
-   * Checks if a TxHashSet is a subset of another TxHashSet.
+   * Checks whether a TxHashSet is a subset of another TxHashSet.
    *
    * **Example** (Checking subset relationships)
    *
@@ -1306,7 +1306,7 @@ export const isSubset: {
    */
   <V1>(that: TxHashSet<V1>): <V0>(self: TxHashSet<V0>) => Effect.Effect<boolean>
   /**
-   * Checks if a TxHashSet is a subset of another TxHashSet.
+   * Checks whether a TxHashSet is a subset of another TxHashSet.
    *
    * **Example** (Checking subset relationships)
    *
@@ -1331,7 +1331,7 @@ export const isSubset: {
   <V0, V1>(self: TxHashSet<V0>, that: TxHashSet<V1>): Effect.Effect<boolean>
 } = dual<
   /**
-   * Checks if a TxHashSet is a subset of another TxHashSet.
+   * Checks whether a TxHashSet is a subset of another TxHashSet.
    *
    * **Example** (Checking subset relationships)
    *
@@ -1355,7 +1355,7 @@ export const isSubset: {
    */
   <V1>(that: TxHashSet<V1>) => <V0>(self: TxHashSet<V0>) => Effect.Effect<boolean>,
   /**
-   * Checks if a TxHashSet is a subset of another TxHashSet.
+   * Checks whether a TxHashSet is a subset of another TxHashSet.
    *
    * **Example** (Checking subset relationships)
    *
@@ -1386,7 +1386,7 @@ export const isSubset: {
   }).pipe(Effect.tx))
 
 /**
- * Tests whether at least one value in the TxHashSet satisfies the predicate.
+ * Checks whether at least one value in the TxHashSet satisfies the predicate.
  *
  * **Example** (Testing whether some values match)
  *
@@ -1409,7 +1409,7 @@ export const isSubset: {
  */
 export const some: {
   /**
-   * Tests whether at least one value in the TxHashSet satisfies the predicate.
+   * Checks whether at least one value in the TxHashSet satisfies the predicate.
    *
    * **Example** (Testing whether some values match)
    *
@@ -1432,7 +1432,7 @@ export const some: {
    */
   <V>(predicate: Predicate<V>): (self: TxHashSet<V>) => Effect.Effect<boolean>
   /**
-   * Tests whether at least one value in the TxHashSet satisfies the predicate.
+   * Checks whether at least one value in the TxHashSet satisfies the predicate.
    *
    * **Example** (Testing whether some values match)
    *
@@ -1456,7 +1456,7 @@ export const some: {
   <V>(self: TxHashSet<V>, predicate: Predicate<V>): Effect.Effect<boolean>
 } = dual<
   /**
-   * Tests whether at least one value in the TxHashSet satisfies the predicate.
+   * Checks whether at least one value in the TxHashSet satisfies the predicate.
    *
    * **Example** (Testing whether some values match)
    *
@@ -1479,7 +1479,7 @@ export const some: {
    */
   <V>(predicate: Predicate<V>) => (self: TxHashSet<V>) => Effect.Effect<boolean>,
   /**
-   * Tests whether at least one value in the TxHashSet satisfies the predicate.
+   * Checks whether at least one value in the TxHashSet satisfies the predicate.
    *
    * **Example** (Testing whether some values match)
    *
@@ -1508,7 +1508,7 @@ export const some: {
   }))
 
 /**
- * Tests whether all values in the TxHashSet satisfy the predicate.
+ * Checks whether all values in the TxHashSet satisfy the predicate.
  *
  * **Example** (Testing whether every value matches)
  *
@@ -1531,7 +1531,7 @@ export const some: {
  */
 export const every: {
   /**
-   * Tests whether all values in the TxHashSet satisfy the predicate.
+   * Checks whether all values in the TxHashSet satisfy the predicate.
    *
    * **Example** (Testing whether every value matches)
    *
@@ -1554,7 +1554,7 @@ export const every: {
    */
   <V>(predicate: Predicate<V>): (self: TxHashSet<V>) => Effect.Effect<boolean>
   /**
-   * Tests whether all values in the TxHashSet satisfy the predicate.
+   * Checks whether all values in the TxHashSet satisfy the predicate.
    *
    * **Example** (Testing whether every value matches)
    *
@@ -1578,7 +1578,7 @@ export const every: {
   <V>(self: TxHashSet<V>, predicate: Predicate<V>): Effect.Effect<boolean>
 } = dual<
   /**
-   * Tests whether all values in the TxHashSet satisfy the predicate.
+   * Checks whether all values in the TxHashSet satisfy the predicate.
    *
    * **Example** (Testing whether every value matches)
    *
@@ -1601,7 +1601,7 @@ export const every: {
    */
   <V>(predicate: Predicate<V>) => (self: TxHashSet<V>) => Effect.Effect<boolean>,
   /**
-   * Tests whether all values in the TxHashSet satisfy the predicate.
+   * Checks whether all values in the TxHashSet satisfy the predicate.
    *
    * **Example** (Testing whether every value matches)
    *

package/src/TxPriorityQueue.ts

@@ -311,8 +311,12 @@ export const isEmpty = <A>(self: TxPriorityQueue<A>): Effect.Effect<boolean> =>
 export const isNonEmpty = <A>(self: TxPriorityQueue<A>): Effect.Effect<boolean> => Effect.map(size(self), (n) => n > 0)
 
 /**
- * Observes the smallest element without removing it. Retries if the queue is
- * empty.
+ * Observes the smallest element without removing it.
+ *
+ * **When to use**
+ *
+ * Use to inspect the next prioritized value and retry transactionally while
+ * the queue is empty.
  *
  * **Example** (Peeking at the next value)
  *
@@ -340,9 +344,13 @@ export const peek = <A>(self: TxPriorityQueue<A>): Effect.Effect<A> =>
   }).pipe(Effect.tx)
 
 /**
- * Observes the smallest element without removing it. Returns `None` if the
+ * Observes the smallest element without removing it, returning `None` when the
  * queue is empty.
  *
+ * **When to use**
+ *
+ * Use to inspect the next prioritized value without retrying on an empty queue.
+ *
  * **Example** (Peeking without retrying)
  *
  * ```ts
@@ -716,7 +724,7 @@ export const removeIf: {
 )
 
 /**
- * Retains only elements matching the predicate.
+ * Keeps only elements matching the predicate.
  *
  * **Example** (Retaining matching values)
  *
@@ -736,7 +744,7 @@ export const removeIf: {
  */
 export const retainIf: {
   /**
-   * Retains only elements matching the predicate.
+   * Keeps only elements matching the predicate.
    *
    * **Example** (Retaining matching values)
    *
@@ -756,7 +764,7 @@ export const retainIf: {
    */
   <A>(predicate: Predicate<A>): (self: TxPriorityQueue<A>) => Effect.Effect<void>
   /**
-   * Retains only elements matching the predicate.
+   * Keeps only elements matching the predicate.
    *
    * **Example** (Retaining matching values)
    *

package/src/TxPubSub.ts

@@ -331,7 +331,7 @@ export const size = <A>(self: TxPubSub<A>): Effect.Effect<number> =>
   }).pipe(Effect.tx)
 
 /**
- * Checks if the TxPubSub has no pending messages (all subscriber queues are empty).
+ * Checks whether the TxPubSub has no pending messages (all subscriber queues are empty).
  *
  * **Example** (Checking whether a pub/sub is empty)
  *
@@ -351,7 +351,7 @@ export const size = <A>(self: TxPubSub<A>): Effect.Effect<number> =>
 export const isEmpty = <A>(self: TxPubSub<A>): Effect.Effect<boolean> => Effect.map(size(self), (s) => s === 0)
 
 /**
- * Checks if any subscriber queue is at capacity.
+ * Checks whether any subscriber queue is at capacity.
  *
  * **Example** (Checking whether a pub/sub is full)
  *
@@ -379,7 +379,7 @@ export const isFull = <A>(self: TxPubSub<A>): Effect.Effect<boolean> =>
   }).pipe(Effect.tx)
 
 /**
- * Checks if the TxPubSub has been shut down.
+ * Checks whether the TxPubSub has been shut down.
  *
  * **Example** (Checking whether a pub/sub is shut down)
  *
@@ -886,7 +886,7 @@ export const awaitShutdown = <A>(self: TxPubSub<A>): Effect.Effect<void> =>
 // =============================================================================
 
 /**
- * Checks if the given value is a TxPubSub.
+ * Checks whether the given value is a TxPubSub.
  *
  * **Example** (Checking for a TxPubSub)
  *

package/src/TxQueue.ts

@@ -286,7 +286,7 @@ export interface TxQueue<in out A, in out E = never> extends TxEnqueue<A, E>, Tx
 }
 
 /**
- * Checks if the given value is a TxEnqueue.
+ * Checks whether the given value is a TxEnqueue.
  *
  * **Example** (Checking enqueue handles)
  *
@@ -307,7 +307,7 @@ export interface TxQueue<in out A, in out E = never> extends TxEnqueue<A, E>, Tx
 export const isTxEnqueue = <A = unknown, E = unknown>(u: unknown): u is TxEnqueue<A, E> => hasProperty(u, EnqueueTypeId)
 
 /**
- * Checks if the given value is a TxDequeue.
+ * Checks whether the given value is a TxDequeue.
  *
  * **Example** (Checking dequeue handles)
  *
@@ -328,7 +328,7 @@ export const isTxEnqueue = <A = unknown, E = unknown>(u: unknown): u is TxEnqueu
 export const isTxDequeue = <A = unknown, E = unknown>(u: unknown): u is TxDequeue<A, E> => hasProperty(u, DequeueTypeId)
 
 /**
- * Checks if the given value is a TxQueue.
+ * Checks whether the given value is a TxQueue.
  *
  * **Example** (Checking queue handles)
  *
@@ -1327,7 +1327,7 @@ export const peek = <A, E>(self: TxDequeue<A, E>): Effect.Effect<A, E> =>
 export const size = (self: TxQueueState): Effect.Effect<number> => TxChunk.size(self.items)
 
 /**
- * Checks if the queue is empty.
+ * Checks whether the queue is empty.
  *
  * **Example** (Checking whether a queue is empty)
  *
@@ -1352,7 +1352,7 @@ export const size = (self: TxQueueState): Effect.Effect<number> => TxChunk.size(
 export const isEmpty = (self: TxQueueState): Effect.Effect<boolean> => TxChunk.isEmpty(self.items)
 
 /**
- * Checks if the queue is at capacity.
+ * Checks whether the queue is at capacity.
  *
  * **Example** (Checking whether a queue is full)
  *
@@ -1380,7 +1380,7 @@ export const isFull = (self: TxQueueState): Effect.Effect<boolean> =>
     : Effect.map(size(self), (currentSize) => currentSize >= self.capacity)
 
 /**
- * Gracefully interrupts the queue with the current fiber's interruption cause.
+ * Interrupts the queue gracefully with the current fiber's interruption cause.
  *
  * **Details**
  *
@@ -1719,7 +1719,7 @@ export const shutdown = <A, E>(self: TxEnqueue<A, E>): Effect.Effect<boolean> =>
   }).pipe(Effect.tx)
 
 /**
- * Checks if the queue is in the open state.
+ * Checks whether the queue is in the open state.
  *
  * **Example** (Checking open state)
  *
@@ -1745,7 +1745,7 @@ export const isOpen = (self: TxQueueState): Effect.Effect<boolean> =>
   Effect.map(TxRef.get(self.stateRef), (state) => state._tag === "Open")
 
 /**
- * Checks if the queue is in the closing state.
+ * Checks whether the queue is in the closing state.
  *
  * **Example** (Checking closing state)
  *
@@ -1772,7 +1772,7 @@ export const isClosing = (self: TxQueueState): Effect.Effect<boolean> =>
   Effect.map(TxRef.get(self.stateRef), (state) => state._tag === "Closing")
 
 /**
- * Checks if the queue is done (completed or failed).
+ * Checks whether the queue is done (completed or failed).
  *
  * **Example** (Checking done state)
  *
@@ -1798,7 +1798,7 @@ export const isDone = (self: TxQueueState): Effect.Effect<boolean> =>
   Effect.map(TxRef.get(self.stateRef), (state) => state._tag === "Done")
 
 /**
- * Checks if the queue is shutdown (legacy compatibility).
+ * Checks whether the queue is shutdown (legacy compatibility).
  *
  * **Example** (Checking shutdown state)
  *

package/src/TxReentrantLock.ts

@@ -193,9 +193,19 @@ export const acquireRead = (self: TxReentrantLock): Effect.Effect<number> =>
   )
 
 /**
- * Acquires a write lock. Blocks if any other fiber holds any lock.
- * If the current fiber already holds the write lock, the count is incremented (reentrancy).
- * If the current fiber holds a read lock, the write lock is granted (upgrade).
+ * Acquires the write lock for the current fiber.
+ *
+ * **When to use**
+ *
+ * Use to enter an exclusive section manually when `withWriteLock` is not the
+ * right shape.
+ *
+ * **Details**
+ *
+ * Blocks if any other fiber holds a read or write lock. If the current fiber
+ * already holds the write lock, the count is incremented. If the current fiber
+ * holds a read lock, the write lock is granted as an upgrade.
+ *
  * Returns the current number of write locks held by this fiber.
  *
  * **Example** (Acquiring a write lock)
@@ -253,7 +263,14 @@ export const acquireWrite = (self: TxReentrantLock): Effect.Effect<number> =>
   )
 
 /**
- * Releases a read lock held by the current fiber.
+ * Releases one read lock held by the current fiber.
+ *
+ * **When to use**
+ *
+ * Use to leave a manually acquired read lock.
+ *
+ * **Details**
+ *
  * Returns the remaining number of read locks held by this fiber.
  *
  * **Example** (Releasing a read lock)
@@ -292,7 +309,14 @@ export const releaseRead = (self: TxReentrantLock): Effect.Effect<number> =>
   )
 
 /**
- * Releases a write lock held by the current fiber.
+ * Releases one write lock held by the current fiber.
+ *
+ * **When to use**
+ *
+ * Use to leave a manually acquired write lock.
+ *
+ * **Details**
+ *
  * Returns the remaining number of write locks held by this fiber.
  *
  * **Example** (Releasing a write lock)
@@ -566,7 +590,11 @@ export const withWriteLock: {
 }) as any
 
 /**
- * Alias for `withWriteLock`. Runs the provided effect while holding a write lock.
+ * Runs an effect while holding a write lock.
+ *
+ * **When to use**
+ *
+ * Use as the short alias for {@link withWriteLock}.
  *
  * **Example** (Running an effect with exclusive access)
  *
@@ -588,7 +616,11 @@ export const withWriteLock: {
  */
 export const withLock: {
   /**
-   * Alias for `withWriteLock`. Runs the provided effect while holding a write lock.
+   * Runs an effect while holding a write lock.
+   *
+   * **When to use**
+   *
+   * Use as the short alias for {@link withWriteLock}.
    *
    * **Example** (Running an effect with exclusive access)
    *
@@ -610,7 +642,11 @@ export const withLock: {
    */
   <A, E, R>(effect: Effect.Effect<A, E, R>): (self: TxReentrantLock) => Effect.Effect<A, E, R>
   /**
-   * Alias for `withWriteLock`. Runs the provided effect while holding a write lock.
+   * Runs an effect while holding a write lock.
+   *
+   * **When to use**
+   *
+   * Use as the short alias for {@link withWriteLock}.
    *
    * **Example** (Running an effect with exclusive access)
    *
@@ -692,7 +728,7 @@ export const writeLocks = (self: TxReentrantLock): Effect.Effect<number> =>
   })
 
 /**
- * Checks if the lock is held by any fiber (read or write).
+ * Checks whether the lock is held by any fiber (read or write).
  *
  * **Example** (Checking whether a lock is held)
  *
@@ -716,7 +752,7 @@ export const locked = (self: TxReentrantLock): Effect.Effect<boolean> =>
   })
 
 /**
- * Checks if any fiber holds a read lock.
+ * Checks whether any fiber holds a read lock.
  *
  * **Example** (Checking whether a read lock is held)
  *
@@ -740,7 +776,7 @@ export const readLocked = (self: TxReentrantLock): Effect.Effect<boolean> =>
   })
 
 /**
- * Checks if any fiber holds a write lock.
+ * Checks whether any fiber holds a write lock.
  *
  * **Example** (Checking whether a write lock is held)
  *
@@ -768,7 +804,7 @@ export const writeLocked = (self: TxReentrantLock): Effect.Effect<boolean> =>
 // =============================================================================
 
 /**
- * Checks if the given value is a TxReentrantLock.
+ * Checks whether the given value is a TxReentrantLock.
  *
  * **Example** (Checking for TxReentrantLock values)
  *

package/src/TxRef.ts

@@ -149,7 +149,7 @@ export interface TxRef<in out A> extends Pipeable {
 export const make = <A>(initial: A) => Effect.sync(() => makeUnsafe(initial))
 
 /**
- * Synchronously creates a new `TxRef` with the specified initial value.
+ * Creates a new `TxRef` synchronously with the specified initial value.
  *
  * **When to use**
  *

package/src/TxSubscriptionRef.ts

@@ -838,7 +838,7 @@ export const changesStream = <A>(self: TxSubscriptionRef<A>): Stream.Stream<A, n
 // =============================================================================
 
 /**
- * Checks if the given value is a TxSubscriptionRef.
+ * Checks whether the given value is a TxSubscriptionRef.
  *
  * **When to use**
  *

package/src/Types.ts

@@ -354,7 +354,7 @@ export type Equals<X, Y> = (<T>() => T extends X ? 1 : 2) extends <
 export type EqualsWith<A, B, Y, N> = (<T>() => T extends A ? 1 : 2) extends (<T>() => T extends B ? 1 : 2) ? Y : N
 
 /**
- * Checks if an object type contains any of the specified keys.
+ * Checks whether an object type contains any of the specified keys.
  *
  * **When to use**
  *
@@ -382,8 +382,8 @@ export type Has<A, Key extends string> = (Key extends infer K ? K extends keyof
   : true
 
 /**
- * Merges two object types where keys from `Source` take precedence over
- * `Target` on conflict.
+ * Left-biased merge of two object types where keys from `Source` take
+ * precedence over `Target` on conflict.
  *
  * **When to use**
  *
@@ -415,8 +415,8 @@ export type Has<A, Key extends string> = (Key extends infer K ? K extends keyof
 export type MergeLeft<Source, Target> = MergeRight<Target, Source>
 
 /**
- * Merges two object types where keys from `Source` take precedence over
- * `Target` on conflict.
+ * Right-biased merge of two object types where keys from `Source` take
+ * precedence over `Target` on conflict.
  *
  * **When to use**
  *
@@ -1033,7 +1033,7 @@ export type ReasonTags<E> = E extends { readonly reason: { readonly _tag: string
  *
  * **When to use**
  *
- * Use to narrow down to a single reason variant from a nested error type.
+ * Use to extract only the matching reason variant from a nested error type.
  *
  * **Details**
  *
@@ -1070,7 +1070,8 @@ export type ExtractReason<E, K extends string> = E extends { readonly reason: in
  *
  * **When to use**
  *
- * Use to narrow down to a single reason variant from a nested error type.
+ * Use to preserve the original error shape while narrowing its nested reason
+ * field to the matching variant.
  *
  * **Details**
  *

package/src/Unify.ts

@@ -35,17 +35,17 @@
 import { identity } from "./Function.ts"
 
 /**
- * A unique symbol used to identify unification behavior in Effect types.
+ * Defines the unique symbol used to identify unification behavior in Effect types.
  *
  * **When to use**
  *
- * Use to implement the unification protocol on library data types that should
- * widen to a public union type.
+ * Use to define the widened type produced by the `Unify` protocol for a custom
+ * protocol-enabled data type.
  *
  * **Details**
  *
- * This symbol is used internally by the Effect type system to enable automatic
- * unification of Effect types in unions and complex type operations.
+ * This symbol is a type-level protocol key. It describes how a protocol-enabled
+ * type widens during unification and has no runtime behavior.
  *
  * @see {@link typeSymbol} for storing the source type information used during unification
  * @see {@link ignoreSymbol} for excluding protocol entries from unification
@@ -60,8 +60,8 @@ export declare const unifySymbol: unique symbol
  *
  * **When to use**
  *
- * Use to reference the `unifySymbol` property key in type-level protocol
- * definitions.
+ * Use to reference the unification behavior property key in type-level
+ * protocol definitions.
  *
  * **Details**
  *
@@ -75,17 +75,17 @@ export declare const unifySymbol: unique symbol
 export type unifySymbol = typeof unifySymbol
 
 /**
- * A unique symbol used to identify the type information for unification.
+ * Defines the unique symbol used to identify the type information for unification.
  *
  * **When to use**
  *
- * Use to implement the unification protocol on types that need to expose their
- * original type information.
+ * Use with `unifySymbol` to expose the source type that unification should read
+ * from a protocol-enabled data type.
  *
  * **Details**
  *
- * This symbol is used internally by the Effect type system to store type
- * information that can be used during type unification operations.
+ * This symbol is a type-level protocol key. It stores the source type that
+ * unification reads when widening protocol-enabled values.
  *
  * @see {@link unifySymbol} for defining how protocol entries widen
  *
@@ -99,7 +99,7 @@ export declare const typeSymbol: unique symbol
  *
  * **When to use**
  *
- * Use to reference the `typeSymbol` property key in type-level protocol
+ * Use to reference the type information property key in type-level protocol
  * definitions.
  *
  * **Details**
@@ -114,17 +114,17 @@ export declare const typeSymbol: unique symbol
 export type typeSymbol = typeof typeSymbol
 
 /**
- * A unique symbol used to specify types that should be ignored during unification.
+ * Defines the unique symbol used to specify types that should be ignored during unification.
  *
  * **When to use**
  *
- * Use to exclude specific protocol properties from type unification.
+ * Use to hide helper protocol entries from `Unify` when they should not
+ * contribute to the widened type.
  *
  * **Details**
  *
- * This symbol is used internally by the Effect type system to mark types
- * that should be excluded from the unification process, allowing for more
- * precise type handling in complex scenarios.
+ * This symbol is a type-level protocol key. It lists protocol entries that
+ * unification should ignore when computing the widened type.
  *
  * @see {@link unifySymbol} for defining the protocol entries being filtered
  *
@@ -138,7 +138,7 @@ export declare const ignoreSymbol: unique symbol
  *
  * **When to use**
  *
- * Use to reference the `ignoreSymbol` property key in type-level protocol
+ * Use to reference the ignored-property key in type-level protocol
  * definitions.
  *
  * **Details**

package/src/Utils.ts

@@ -61,7 +61,7 @@ import type { Kind, TypeLambda } from "./HKT.ts"
 import type * as Types from "./Types.ts"
 
 /**
- * An `IterableIterator` that yields its wrapped value exactly once.
+ * Yields its wrapped value exactly once through an `IterableIterator`.
  *
  * **When to use**
  *
@@ -75,7 +75,6 @@ import type * as Types from "./Types.ts"
  * subsequent call returns `{ value: a, done: true }` where `a` is the argument
  * passed to `next()`. `[Symbol.iterator]()` returns a **new** `SingleShotGen`
  * wrapping the same value, so the outer type can be iterated multiple times.
- * It does not mutate the wrapped value.
  *
  * **Example** (Yielding a wrapped value in a generator)
  *