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

package/src/Effectable.ts

@@ -55,7 +55,7 @@ import { evaluate, makePrimitiveProto } from "./internal/core.ts"
  *
  * @see {@link Class} for a class-based approach to defining custom Effect values
  *
- * @category Prototypes
+ * @category prototypes
  * @since 4.0.0
  */
 export const Prototype = <A extends Effect.Effect<any, any, any>>(options: {
@@ -82,7 +82,7 @@ const Base: new<A, E, R>() => Effect.Effect<A, E, R> = (() => {
 })()
 
 /**
- * An abstract class that can be extended to create an `Effect`.
+ * Provides an abstract class that can be extended to create an `Effect`.
  *
  * **When to use**
  *

package/src/Encoding.ts

@@ -60,11 +60,14 @@ import * as Result from "./Result.ts"
  * Type identifier stored on `EncodingError` values and used by
  * `isEncodingError`.
  *
- * **When to use**
+ * **Details**
+ *
+ * This marker is part of the runtime representation of `EncodingError`. Prefer
+ * `isEncodingError` when narrowing unknown values.
  *
- * Use to identify `EncodingError` values at runtime.
+ * @see {@link isEncodingError} for the public guard that checks this marker
  *
- * @category symbols
+ * @category type IDs
  * @since 4.0.0
  */
 export const EncodingErrorTypeId = "~effect/encoding/EncodingError" as const
@@ -76,7 +79,7 @@ export const EncodingErrorTypeId = "~effect/encoding/EncodingError" as const
  *
  * Use to type the marker carried by `EncodingError` values.
  *
- * @category symbols
+ * @category type IDs
  * @since 4.0.0
  */
 export type EncodingErrorTypeId = typeof EncodingErrorTypeId
@@ -181,7 +184,7 @@ export const encodeBase64: (input: Uint8Array | string) => string = (input) =>
   typeof input === "string" ? base64EncodeUint8Array(encoder.encode(input)) : base64EncodeUint8Array(input)
 
 /**
- * Decodes a base64 (RFC4648) string into bytes.
+ * Decodes a base64 (RFC4648) string into bytes safely.
  *
  * **When to use**
  *
@@ -261,7 +264,7 @@ export const decodeBase64 = (str: string): Result.Result<Uint8Array, EncodingErr
 }
 
 /**
- * Decodes a base64 (RFC4648) string into a UTF-8 string.
+ * Decodes a base64 (RFC4648) string into a UTF-8 string safely.
  *
  * **When to use**
  *
@@ -330,7 +333,7 @@ export const encodeBase64Url: (input: Uint8Array | string) => string = (input) =
   typeof input === "string" ? base64UrlEncodeUint8Array(encoder.encode(input)) : base64UrlEncodeUint8Array(input)
 
 /**
- * Decodes a URL-safe base64 string into bytes.
+ * Decodes a URL-safe base64 string into bytes safely.
  *
  * **When to use**
  *
@@ -391,7 +394,7 @@ export const decodeBase64Url = (str: string): Result.Result<Uint8Array, Encoding
 }
 
 /**
- * Decodes a URL-safe base64 string into a UTF-8 string.
+ * Decodes a URL-safe base64 string into a UTF-8 string safely.
  *
  * **When to use**
  *
@@ -451,7 +454,7 @@ export const encodeHex: (input: Uint8Array | string) => string = (input) =>
   typeof input === "string" ? hexEncodeUint8Array(encoder.encode(input)) : hexEncodeUint8Array(input)
 
 /**
- * Decodes a hexadecimal string into bytes.
+ * Decodes a hexadecimal string into bytes safely.
  *
  * **When to use**
  *
@@ -513,7 +516,7 @@ export const decodeHex = (str: string): Result.Result<Uint8Array, EncodingError>
 }
 
 /**
- * Decodes a hexadecimal string into a UTF-8 string.
+ * Decodes a hexadecimal string into a UTF-8 string safely.
  *
  * **When to use**
  *

package/src/Equal.ts

@@ -75,7 +75,7 @@ import { byReferenceInstances, getAllObjectKeys } from "./internal/equal.ts"
 import { hasProperty } from "./Predicate.ts"
 
 /**
- * The unique string identifier for the {@link Equal} interface.
+ * Defines the unique string identifier for the `Equal` interface.
  *
  * **When to use**
  *
@@ -170,7 +170,7 @@ export interface Equal extends Hash.Hash {
 }
 
 /**
- * Compares two values for deep structural equality.
+ * Checks whether two values are deeply structurally equal.
  *
  * **When to use**
  *
@@ -576,8 +576,7 @@ export const asEquivalence: <A>() => Equivalence<A> = () => equals
 export const byReference = <T extends object>(obj: T): T => byReferenceUnsafe(new Proxy(obj, {}))
 
 /**
- * Permanently marks an object to use reference equality, without creating a
- * proxy.
+ * Marks an object permanently to use reference equality, without creating a proxy.
  *
  * **When to use**
  *

package/src/Equivalence.ts

@@ -66,7 +66,6 @@ import * as Reducer from "./Reducer.ts"
  *
  * **Details**
  *
- * - Pure function: does not mutate inputs or have side effects
  * - Returns `boolean`: `true` if values are equivalent, `false` otherwise
  * - Must satisfy reflexive, symmetric, and transitive properties
  *
@@ -154,7 +153,6 @@ export interface EquivalenceTypeLambda extends TypeLambda {
  *
  * **Details**
  *
- * - Does not mutate inputs
  * - First checks reference equality (`===`) for performance; if values are identical, returns `true` without calling the function
  * - Falls back to the provided equivalence function if values are not the same reference
  * - The provided function must satisfy reflexive, symmetric, and transitive properties
@@ -209,7 +207,6 @@ const isStrictEquivalent = (x: unknown, y: unknown) => x === y
  *
  * **Details**
  *
- * - Does not mutate inputs
  * - Uses JavaScript's strict equality operator (`===`)
  * - For primitives: compares values directly
  * - For objects: compares by reference, so only the same object instance is equivalent
@@ -250,7 +247,7 @@ const isStrictEquivalent = (x: unknown, y: unknown) => x === y
 export const strictEqual: <A>() => Equivalence<A> = () => isStrictEquivalent
 
 /**
- * An `Equivalence` instance for strings using strict equality (`===`).
+ * Equivalence instance for strings using strict equality (`===`).
  *
  * **When to use**
  *
@@ -271,7 +268,7 @@ export const strictEqual: <A>() => Equivalence<A> = () => isStrictEquivalent
 export const String: Equivalence<string> = isStrictEquivalent
 
 /**
- * An `Equivalence` instance for numbers.
+ * Equivalence instance for numbers.
  *
  * **When to use**
  *
@@ -300,7 +297,7 @@ export const Number: Equivalence<number> = make((self, that) =>
 )
 
 /**
- * An `Equivalence` instance for booleans using strict equality (`===`).
+ * Equivalence instance for booleans using strict equality (`===`).
  *
  * **When to use**
  *
@@ -321,7 +318,7 @@ export const Number: Equivalence<number> = make((self, that) =>
 export const Boolean: Equivalence<boolean> = isStrictEquivalent
 
 /**
- * An `Equivalence` instance for bigints using strict equality (`===`).
+ * Equivalence instance for bigints using strict equality (`===`).
  *
  * **When to use**
  *
@@ -352,7 +349,6 @@ export const BigInt: Equivalence<bigint> = isStrictEquivalent
  *
  * **Details**
  *
- * - Does not mutate inputs
  * - Returns `true` only if both equivalences return `true`
  * - Short-circuits: if the first equivalence returns `false`, the second is not called
  * - The result is also an equivalence that satisfies reflexive, symmetric, and transitive properties
@@ -404,7 +400,6 @@ export const combine: {
    *
    * **Details**
    *
-   * - Does not mutate inputs
    * - Returns `true` only if both equivalences return `true`
    * - Short-circuits: if the first equivalence returns `false`, the second is not called
    * - The result is also an equivalence that satisfies reflexive, symmetric, and transitive properties
@@ -456,7 +451,6 @@ export const combine: {
    *
    * **Details**
    *
-   * - Does not mutate inputs
    * - Returns `true` only if both equivalences return `true`
    * - Short-circuits: if the first equivalence returns `false`, the second is not called
    * - The result is also an equivalence that satisfies reflexive, symmetric, and transitive properties
@@ -511,7 +505,6 @@ export const combine: {
  *
  * **Details**
  *
- * - Does not mutate inputs
  * - Returns `true` only if all equivalences in the collection return `true`
  * - Short-circuits: stops at the first equivalence that returns `false`
  * - Empty collections return an equivalence that always returns `true`
@@ -588,7 +581,6 @@ export const combineAll = <A>(collection: Iterable<Equivalence<A>>): Equivalence
  *
  * **Details**
  *
- * - Does not mutate inputs
  * - Applies the transformation function to both values before comparing
  * - The transformation function should be pure and have no side effects
  * - The resulting equivalence compares the transformed values using the provided equivalence
@@ -651,7 +643,6 @@ export const mapInput: {
    *
    * **Details**
    *
-   * - Does not mutate inputs
    * - Applies the transformation function to both values before comparing
    * - The transformation function should be pure and have no side effects
    * - The resulting equivalence compares the transformed values using the provided equivalence
@@ -714,7 +705,6 @@ export const mapInput: {
    *
    * **Details**
    *
-   * - Does not mutate inputs
    * - Applies the transformation function to both values before comparing
    * - The transformation function should be pure and have no side effects
    * - The resulting equivalence compares the transformed values using the provided equivalence
@@ -782,7 +772,6 @@ export const mapInput: {
  *
  * **Details**
  *
- * - Does not mutate inputs
  * - Requires tuples to have the same length; different lengths are never equivalent
  * - Applies each equivalence to the corresponding element position
  * - Returns `true` only if all elements are equivalent according to their respective equivalences
@@ -874,7 +863,6 @@ export {
    *
    * **Details**
    *
-   * - Does not mutate inputs
    * - Requires arrays to have the same length; different lengths are never equivalent
    * - Compares elements positionally, such as index `0` with index `0`
    * - Returns `true` only if all corresponding elements are equivalent
@@ -929,7 +917,6 @@ export {
  *
  * **Details**
  *
- * - Does not mutate inputs
  * - Compares only the properties specified in the struct definition
  * - Properties not in the struct are ignored
  * - Returns `true` only if all specified properties are equivalent according to their equivalences
@@ -1012,7 +999,6 @@ export function Struct<R extends Record<string, Equivalence<any>>>(
  *
  * **Details**
  *
- * - Does not mutate inputs
  * - Compares all properties present in both objects
  * - Requires both objects to have the same set of keys; different keys result in `false`
  * - All property values must be equivalent according to the provided equivalence
@@ -1120,7 +1106,7 @@ export function makeReducer<A>() {
 }
 
 /**
- * An `Equivalence` instance for `Date` objects that compares their `getTime()` values using `Equivalence.Number`.
+ * Equivalence instance for `Date` objects that compares their `getTime()` values using `Equivalence.Number`.
  *
  * **When to use**
  *

package/src/ErrorReporter.ts

@@ -69,7 +69,7 @@ import type * as Scope from "./Scope.ts"
  *
  * Use to refer to the runtime type identifier type in low-level integrations.
  *
- * @category Type Identifiers
+ * @category type IDs
  * @since 4.0.0
  */
 export type TypeId = "~effect/ErrorReporter"
@@ -77,11 +77,13 @@ export type TypeId = "~effect/ErrorReporter"
 /**
  * Runtime type identifier attached to `ErrorReporter` values.
  *
- * **When to use**
+ * **Details**
  *
- * Use to compare or attach the runtime identifier for `ErrorReporter` values.
+ * This marker is part of the runtime representation of `ErrorReporter`
+ * implementations. Most code should create reporters with `make` and register
+ * them with `layer`.
  *
- * @category Type Identifiers
+ * @category type IDs
  * @since 4.0.0
  */
 export const TypeId: TypeId = "~effect/ErrorReporter"
@@ -192,7 +194,7 @@ export const make = (
 }
 
 /**
- * A `Context.Reference` holding the set of active `ErrorReporter`s for the
+ * Context reference that holds the set of active error reporters for the
  * current fiber. Defaults to an empty set (no reporting).
  *
  * **When to use**
@@ -284,8 +286,7 @@ export const layer = <
   )
 
 /**
- * Manually reports a `Cause` to all registered `ErrorReporter`s on the
- * current fiber.
+ * Runs all registered error reporters on the current fiber for a `Cause`.
  *
  * **When to use**
  *
@@ -349,7 +350,7 @@ declare global {
 }
 
 /**
- * String property key used to mark an object error as ignored by error
+ * Defines the string property key used to mark an object error as ignored by error
  * reporting.
  *
  * **When to use**
@@ -369,7 +370,7 @@ declare global {
 export type ignore = "~effect/ErrorReporter/ignore"
 
 /**
- * Runtime property key used to mark an object error as ignored by error
+ * Defines the runtime property key used to mark an object error as ignored by error
  * reporting.
  *
  * **When to use**
@@ -420,7 +421,7 @@ export const isIgnored = (u: unknown): boolean =>
   typeof u === "object" && u !== null && ignore in u && u[ignore] === true
 
 /**
- * String property key used to override the severity level of an object error.
+ * Defines the string property key used to override the severity level of an object error.
  *
  * **When to use**
  *
@@ -438,7 +439,7 @@ export const isIgnored = (u: unknown): boolean =>
 export type severity = "~effect/ErrorReporter/severity"
 
 /**
- * Runtime property key used to override the severity level of an object error.
+ * Defines the runtime property key used to override the severity level of an object error.
  *
  * **When to use**
  *
@@ -492,7 +493,7 @@ export const getSeverity = (error: object): Severity => {
 }
 
 /**
- * String property key used to attach extra key/value metadata to an object
+ * Defines the string property key used to attach extra key/value metadata to an object
  * error report.
  *
  * **When to use**
@@ -511,7 +512,7 @@ export const getSeverity = (error: object): Severity => {
 export type attributes = "~effect/ErrorReporter/attributes"
 
 /**
- * Runtime property key used to attach extra key/value metadata to an object
+ * Defines the runtime property key used to attach extra key/value metadata to an object
  * error report.
  *
  * **When to use**

package/src/ExecutionPlan.ts

@@ -470,10 +470,15 @@ export interface Metadata {
 }
 
 /**
- * `Context.Reference` containing metadata for the currently running
+ * Context reference containing metadata for the currently running
  * execution-plan attempt.
  *
- * @category Metadata
+ * **When to use**
+ *
+ * Use to read the active plan step and attempt while code is running under an
+ * execution plan.
+ *
+ * @category metadata
  * @since 4.0.0
  */
 export const CurrentMetadata = Context.Reference<Metadata>("effect/ExecutionPlan/CurrentMetadata", {

package/src/Exit.ts

@@ -140,8 +140,9 @@ export declare namespace Exit {
  *
  * **When to use**
  *
- * Use when you use {@link isSuccess} to narrow an `Exit` to `Success`
- * - Access the value via the `value` property after narrowing
+ * Use when working with the successful branch of an `Exit` after narrowing
+ * with {@link isSuccess}. Access the value via the `value` property after
+ * narrowing.
  *
  * **Example** (Accessing the success value)
  *
@@ -172,8 +173,9 @@ export interface Success<out A, out E = never> extends Exit.Proto<A, E> {
  *
  * **When to use**
  *
- * Use when you use {@link isFailure} to narrow an `Exit` to `Failure`
- * - Access the cause via the `cause` property after narrowing
+ * Use when working with the failed branch of an `Exit` after narrowing with
+ * {@link isFailure}. Access the cause via the `cause` property after
+ * narrowing.
  *
  * **Details**
  *
@@ -204,7 +206,7 @@ export interface Failure<out A, out E> extends Exit.Proto<A, E> {
 }
 
 /**
- * Tests whether an unknown value is an Exit.
+ * Checks whether an unknown value is an Exit.
  *
  * **When to use**
  *
@@ -390,7 +392,7 @@ export const interrupt: (fiberId?: number | undefined) => Exit<never> = effect.e
 const void_: Exit<void> = effect.exitVoid
 export {
   /**
-   * A pre-allocated successful Exit with a `void` value.
+   * Provides a pre-allocated successful Exit with a `void` value.
    *
    * **When to use**
    *
@@ -420,7 +422,7 @@ export {
 }
 
 /**
- * Tests whether an Exit is a Success.
+ * Checks whether an Exit is a Success.
  *
  * **When to use**
  *
@@ -448,7 +450,7 @@ export {
 export const isSuccess: <A, E>(self: Exit<A, E>) => self is Success<A, E> = effect.exitIsSuccess
 
 /**
- * Tests whether an Exit is a Failure.
+ * Checks whether an Exit is a Failure.
  *
  * **When to use**
  *
@@ -476,7 +478,7 @@ export const isSuccess: <A, E>(self: Exit<A, E>) => self is Success<A, E> = effe
 export const isFailure: <A, E>(self: Exit<A, E>) => self is Failure<A, E> = effect.exitIsFailure
 
 /**
- * Tests whether a failed Exit contains typed errors (Fail reasons).
+ * Checks whether a failed Exit contains typed errors (Fail reasons).
  *
  * **When to use**
  *
@@ -508,7 +510,7 @@ export const isFailure: <A, E>(self: Exit<A, E>) => self is Failure<A, E> = effe
 export const hasFails: <A, E>(self: Exit<A, E>) => self is Failure<A, E> = effect.exitHasFails
 
 /**
- * Tests whether a failed Exit contains defects (Die reasons).
+ * Checks whether a failed Exit contains defects (Die reasons).
  *
  * **When to use**
  *
@@ -540,7 +542,7 @@ export const hasFails: <A, E>(self: Exit<A, E>) => self is Failure<A, E> = effec
 export const hasDies: <A, E>(self: Exit<A, E>) => self is Failure<A, E> = effect.exitHasDies
 
 /**
- * Tests whether a failed Exit contains interruptions (Interrupt reasons).
+ * Checks whether a failed Exit contains interruptions (Interrupt reasons).
  *
  * **When to use**
  *
@@ -577,7 +579,7 @@ export const hasInterrupts: <A, E>(self: Exit<A, E>) => self is Failure<A, E> =
  * **When to use**
  *
  * Use when composing Exit checks with `Filter` or other `Result`-based
- * filtering APIs.
+ * filtering APIs and you want the full Success wrapper.
  *
  * **Details**
  *
@@ -654,7 +656,7 @@ export const filterValue: <A, E>(self: Exit<A, E>) => Result.Result<A, Failure<n
  * **When to use**
  *
  * Use when composing Exit checks with `Filter` or other `Result`-based
- * filtering APIs.
+ * filtering APIs and you want the full Failure wrapper.
  *
  * **Details**
  *
@@ -929,7 +931,7 @@ export const match: {
  *
  * - Has no effect on failures, which pass through unchanged
  *
- * Allocates a new Exit if successful. Does not mutate the input.
+ * Allocates a new Exit if successful.
  * Supports both curried and direct call styles.
  *
  * **Example** (Mapping over a success)
@@ -960,7 +962,7 @@ export const map: {
    *
    * - Has no effect on failures, which pass through unchanged
    *
-   * Allocates a new Exit if successful. Does not mutate the input.
+   * Allocates a new Exit if successful.
    * Supports both curried and direct call styles.
    *
    * **Example** (Mapping over a success)
@@ -991,7 +993,7 @@ export const map: {
    *
    * - Has no effect on failures, which pass through unchanged
    *
-   * Allocates a new Exit if successful. Does not mutate the input.
+   * Allocates a new Exit if successful.
    * Supports both curried and direct call styles.
    *
    * **Example** (Mapping over a success)
@@ -1024,7 +1026,7 @@ export const map: {
  *
  * - Has no effect on successes, which pass through unchanged
  *
- * Allocates a new Exit if the error is transformed. Does not mutate the input.
+ * Allocates a new Exit if the error is transformed.
  * Supports both curried and direct call styles.
  *
  * **Gotchas**
@@ -1062,7 +1064,7 @@ export const mapError: {
    *
    * - Has no effect on successes, which pass through unchanged
    *
-   * Allocates a new Exit if the error is transformed. Does not mutate the input.
+   * Allocates a new Exit if the error is transformed.
    * Supports both curried and direct call styles.
    *
    * **Gotchas**
@@ -1100,7 +1102,7 @@ export const mapError: {
    *
    * - Has no effect on successes, which pass through unchanged
    *
-   * Allocates a new Exit if the error is transformed. Does not mutate the input.
+   * Allocates a new Exit if the error is transformed.
    * Supports both curried and direct call styles.
    *
    * **Gotchas**
@@ -1141,7 +1143,7 @@ export const mapError: {
  * - `onSuccess` transforms the value if the Exit is a Success
  * - `onFailure` transforms the typed error if the Exit is a Failure with a Fail reason
  *
- * Allocates a new Exit. Does not mutate the input.
+ * Allocates a new Exit.
  * Supports both curried and direct call styles.
  *
  * **Gotchas**
@@ -1183,7 +1185,7 @@ export const mapBoth: {
    * - `onSuccess` transforms the value if the Exit is a Success
    * - `onFailure` transforms the typed error if the Exit is a Failure with a Fail reason
    *
-   * Allocates a new Exit. Does not mutate the input.
+   * Allocates a new Exit.
    * Supports both curried and direct call styles.
    *
    * **Gotchas**
@@ -1227,7 +1229,7 @@ export const mapBoth: {
    * - `onSuccess` transforms the value if the Exit is a Success
    * - `onFailure` transforms the typed error if the Exit is a Failure with a Fail reason
    *
-   * Allocates a new Exit. Does not mutate the input.
+   * Allocates a new Exit.
    * Supports both curried and direct call styles.
    *
    * **Gotchas**
@@ -1273,7 +1275,7 @@ export const mapBoth: {
  *
  * - Failures pass through unchanged
  *
- * Allocates a new Exit if successful. Does not mutate the input.
+ * Allocates a new Exit if successful.
  *
  * **Example** (Discarding the success value)
  *

package/src/Fiber.ts

@@ -769,7 +769,7 @@ export const interruptAllAs: {
 } = effect.fiberInterruptAllAs
 
 /**
- * Tests if a value is a Fiber. This is a type guard that can be used to
+ * Checks whether a value is a Fiber. This is a type guard that can be used to
  * determine if an unknown value is a Fiber instance.
  *
  * **When to use**
@@ -846,7 +846,7 @@ export const isFiber = (
 export const getCurrent: () => Fiber<any, any> | undefined = effect.getCurrentFiber
 
 /**
- * Links a fiber to a `Scope` and returns the same fiber.
+ * Adds a fiber to a `Scope` and returns the same fiber.
  *
  * **When to use**
  *
@@ -869,7 +869,7 @@ export const getCurrent: () => Fiber<any, any> | undefined = effect.getCurrentFi
  */
 export const runIn: {
   /**
-   * Links a fiber to a `Scope` and returns the same fiber.
+   * Adds a fiber to a `Scope` and returns the same fiber.
    *
    * **When to use**
    *
@@ -892,7 +892,7 @@ export const runIn: {
    */
   (scope: Scope): <A, E>(self: Fiber<A, E>) => Fiber<A, E>
   /**
-   * Links a fiber to a `Scope` and returns the same fiber.
+   * Adds a fiber to a `Scope` and returns the same fiber.
    *
    * **When to use**
    *

package/src/FiberHandle.ts

@@ -284,7 +284,7 @@ const isInternalInterruption = Filter.toPredicate(Filter.compose(
 ))
 
 /**
- * Set the fiber in a FiberHandle. When the fiber completes, it will be removed from the FiberHandle.
+ * Sets the fiber in a FiberHandle. When the fiber completes, it will be removed from the FiberHandle.
  * If a fiber is already running, it will be interrupted unless `options.onlyIfMissing` is set.
  *
  * **Example** (Setting a fiber unsafely)
@@ -310,7 +310,7 @@ const isInternalInterruption = Filter.toPredicate(Filter.compose(
  */
 export const setUnsafe: {
   /**
-   * Set the fiber in a FiberHandle. When the fiber completes, it will be removed from the FiberHandle.
+   * Sets the fiber in a FiberHandle. When the fiber completes, it will be removed from the FiberHandle.
    * If a fiber is already running, it will be interrupted unless `options.onlyIfMissing` is set.
    *
    * **Example** (Setting a fiber unsafely)
@@ -342,7 +342,7 @@ export const setUnsafe: {
     }
   ): (self: FiberHandle<A, E>) => void
   /**
-   * Set the fiber in a FiberHandle. When the fiber completes, it will be removed from the FiberHandle.
+   * Sets the fiber in a FiberHandle. When the fiber completes, it will be removed from the FiberHandle.
    * If a fiber is already running, it will be interrupted unless `options.onlyIfMissing` is set.
    *
    * **Example** (Setting a fiber unsafely)
@@ -536,7 +536,7 @@ export const set: {
   ))
 
 /**
- * Retrieve the fiber from the FiberHandle.
+ * Retrieves the fiber from the FiberHandle synchronously.
  *
  * **Example** (Reading the current fiber unsafely)
  *
@@ -565,7 +565,7 @@ export function getUnsafe<A, E>(self: FiberHandle<A, E>): Option.Option<Fiber.Fi
 }
 
 /**
- * Retrieve the fiber from the FiberHandle.
+ * Retrieves the fiber from the FiberHandle effectfully.
  *
  * **Example** (Reading the current fiber)
  *
@@ -972,7 +972,7 @@ export const join = <A, E>(self: FiberHandle<A, E>): Effect.Effect<void, E> =>
   Deferred.await(self.deferred as Deferred.Deferred<void, E>)
 
 /**
- * Wait for the fiber in the FiberHandle to complete.
+ * Waits for the fiber in the FiberHandle to complete.
  *
  * **Example** (Waiting for a fiber to complete)
  *