effect 4.0.0-beta.69 → 4.0.0-beta.70

package/src/Redactable.ts

@@ -74,12 +74,16 @@ import { hasProperty } from "./Predicate.ts"
  * Symbol used to identify objects that implement the {@link Redactable}
  * protocol.
  *
- * Add a method under this key to make an object redactable. The method
- * receives the current `Context` and must return the replacement value.
+ * **When to use**
  *
- * - Use this symbol as the property key when implementing {@link Redactable}.
- * - Registered globally via `Symbol.for("~effect/Redactable")`,
- *   so it is identical across multiple copies of the library at runtime.
+ * Use this symbol as the property key when implementing {@link Redactable}.
+ *
+ * **Details**
+ *
+ * Add a method under this key to make an object redactable. The method receives
+ * the current `Context` and must return the replacement value. The symbol is
+ * registered globally via `Symbol.for("~effect/Redactable")`, so it is
+ * identical across multiple copies of the library at runtime.
  *
  * **Example** (Masking an API key)
  *
@@ -95,10 +99,8 @@ import { hasProperty } from "./Predicate.ts"
  * }
  * ```
  *
- * See also:
- * - {@link Redactable} - the interface this symbol belongs to
- * - {@link isRedactable} - check whether a value has this symbol
- *
+ * @see {@link Redactable} - the interface this symbol belongs to
+ * @see {@link isRedactable} - check whether a value has this symbol
  * @category symbol
  * @since 3.10.0
  */
@@ -107,10 +109,15 @@ export const symbolRedactable: unique symbol = Symbol.for("~effect/Redactable")
 /**
  * Interface for objects that provide context-aware redacted representations.
  *
- * - Implement this interface on any class or object that holds sensitive data
- *   and should present a sanitized form when inspected or logged.
- * - The `[symbolRedactable]` method receives the current fiber's `Context`.
- * - If no fiber is active, an empty `Context` is provided.
+ * **When to use**
+ *
+ * Implement this interface on any class or object that holds sensitive data and
+ * should present a sanitized form when inspected or logged.
+ *
+ * **Details**
+ *
+ * The `[symbolRedactable]` method receives the current fiber's `Context`. If no
+ * fiber is active, an empty `Context` is provided.
  *
  * **Example** (Masking an API key)
  *
@@ -126,11 +133,9 @@ export const symbolRedactable: unique symbol = Symbol.for("~effect/Redactable")
  * }
  * ```
  *
- * See also:
- * - {@link symbolRedactable} - the symbol key to implement
- * - {@link redact} - apply redaction to any value
- * - {@link isRedactable} - type guard for this interface
- *
+ * @see {@link symbolRedactable} - the symbol key to implement
+ * @see {@link redact} - apply redaction to any value
+ * @see {@link isRedactable} - type guard for this interface
  * @category models
  * @since 3.10.0
  */
@@ -142,10 +147,8 @@ export interface Redactable {
  * Type guard that checks whether a value implements the {@link Redactable}
  * interface.
  *
- * See also:
- * - {@link Redactable} - the interface being checked
- * - {@link redact} - applies redaction if the value is redactable
- *
+ * @see {@link Redactable} - the interface being checked
+ * @see {@link redact} - applies redaction if the value is redactable
  * @category guards
  * @since 3.10.0
  */
@@ -155,18 +158,23 @@ export const isRedactable = (u: unknown): u is Redactable => hasProperty(u, symb
  * Redacts a value if it implements {@link Redactable}, otherwise returns it
  * unchanged.
  *
- * - Use this as the general-purpose entry point for redaction: it is safe to
- *   call on any value.
- * - Internally calls {@link isRedactable} and, if `true`, delegates to
- *   {@link getRedacted}.
- * - Not recursive: nested redactable values inside the returned object are not
- *   automatically redacted.
- * - Pure with respect to its argument (does not mutate the input).
+ * **When to use**
  *
- * See also:
- * - {@link isRedactable} - check before redacting
- * - {@link getRedacted} - lower-level variant for known redactables
+ * Use this as the general-purpose entry point for redaction when the input may
+ * or may not implement the redaction protocol.
  *
+ * **Details**
+ *
+ * This function calls {@link isRedactable} and, when it returns `true`,
+ * delegates to {@link getRedacted}. It does not mutate the input.
+ *
+ * **Gotchas**
+ *
+ * Redaction is not recursive. Nested redactable values inside the returned
+ * object are not automatically redacted.
+ *
+ * @see {@link isRedactable} - check before redacting
+ * @see {@link getRedacted} - lower-level variant for known redactables
  * @category destructors
  * @since 3.10.0
  */
@@ -179,17 +187,22 @@ export function redact(u: unknown): unknown {
  * Calls `[symbolRedactable]` on a value that is already known to be
  * {@link Redactable} and returns the result.
  *
- * - Use this when you have already verified the value is `Redactable` (e.g.,
- *   via {@link isRedactable}) and want to avoid a second check.
- * - Reads the current fiber's `Context` from the global fiber reference. If
- *   no fiber is active, an empty `Context` is passed to the redaction
- *   method.
- * - Does not mutate the input.
+ * **When to use**
+ *
+ * Use this when you have already verified the value is `Redactable`, for
+ * example with {@link isRedactable}, and want to avoid a second check.
+ *
+ * **Details**
+ *
+ * This function reads the current fiber's `Context` from the global fiber
+ * reference and passes it to the redaction method. It does not mutate the input.
+ *
+ * **Gotchas**
  *
- * See also:
- * - {@link redact} - higher-level variant that handles non-redactable values
- * - {@link isRedactable} - type guard to verify before calling this
+ * If no fiber is active, an empty `Context` is passed to the redaction method.
  *
+ * @see {@link redact} - higher-level variant that handles non-redactable values
+ * @see {@link isRedactable} - type guard to verify before calling this
  * @category destructors
  * @since 4.0.0
  */

package/src/Redacted.ts

@@ -21,6 +21,8 @@ const TypeId = "~effect/data/Redacted"
  * A wrapper for sensitive values whose string, JSON, and inspection output is
  * redacted.
  *
+ * **Gotchas**
+ *
  * The underlying value is still stored in memory and can be recovered with
  * `Redacted.value` until the wrapper is wiped or becomes unreachable. Use
  * `Redacted` to reduce accidental disclosure in logs and diagnostics, not as a
@@ -66,6 +68,8 @@ export declare namespace Redacted {
   /**
    * Type-level variance marker for `Redacted`.
    *
+   * **Details**
+   *
    * This interface records the covariant value type carried by a `Redacted`
    * value and is not normally referenced directly by users.
    *
@@ -105,6 +109,8 @@ export declare namespace Redacted {
 /**
  * Returns `true` if a value is a `Redacted` wrapper.
  *
+ * **Details**
+ *
  * When this function returns `true`, TypeScript narrows the value to
  * `Redacted<unknown>`.
  *
@@ -128,6 +134,8 @@ export const isRedacted = (u: unknown): u is Redacted<unknown> => hasProperty(u,
 /**
  * Creates a `Redacted` wrapper for a sensitive value.
  *
+ * **Details**
+ *
  * The wrapper redacts string, JSON, and inspection output to reduce accidental
  * disclosure. The original value remains retrievable with `Redacted.value`
  * until the wrapper is wiped or becomes unreachable.
@@ -204,6 +212,8 @@ export const value: <T>(self: Redacted<T>) => T = redacted.value
  * Deletes the stored value for a `Redacted` wrapper, making future
  * `Redacted.value` calls on that wrapper fail.
  *
+ * **Gotchas**
+ *
  * This unsafe operation does not zero memory and does not affect other
  * references to the original value. It only removes the value from the
  * internal redacted registry.

package/src/Reducer.ts

@@ -73,23 +73,28 @@ import type * as Combiner from "./Combiner.ts"
  * Represents a strategy for reducing a collection of values of type `A` into
  * a single result.
  *
- * Extends {@link Combiner.Combiner} with:
- * - `initialValue` – the identity/neutral element for `combine`.
- * - `combineAll` – folds an entire `Iterable<A>` from `initialValue`.
+ * **When to use**
  *
- * When to use:
  * - You need to fold/reduce a collection into a single value.
  * - You want a reusable reducing strategy that can be passed to library
  *   functions like `Struct.makeReducer`, `Option.makeReducer`, or
  *   `Record.makeReducerUnion`.
  * - You need both the combining logic *and* a known starting value.
  *
+ * **Details**
+ *
+ * Extends {@link Combiner.Combiner} with:
+ *
+ * - `initialValue` – the identity/neutral element for `combine`.
+ * - `combineAll` – folds an entire `Iterable<A>` from `initialValue`.
+ *
  * Many modules ship pre-built reducers:
+ *
  * - `Number.ReducerSum`, `Number.ReducerMultiply`
  * - `String.ReducerConcat`
  * - `Boolean.ReducerAnd`, `Boolean.ReducerOr`
  *
- * **Example** (string concatenation reducer)
+ * **Example** (String concatenation reducer)
  *
  * ```ts
  * import { Reducer } from "effect"
@@ -117,18 +122,20 @@ export interface Reducer<A> extends Combiner.Combiner<A> {
 /**
  * Creates a `Reducer` from a `combine` function and an `initialValue`.
  *
- * When to use:
+ * **When to use**
+ *
  * - You have a custom reducing operation not covered by a pre-built reducer.
  * - You want to provide an optimized `combineAll` (e.g. short-circuiting on
  *   a known absorbing element like `0` for multiplication).
  *
- * Behavior:
+ * **Details**
+ *
  * - If `combineAll` is omitted, a default left-to-right fold starting from
  *   `initialValue` is used.
  * - If `combineAll` is provided, it completely replaces the default fold.
  * - Pure – the returned reducer does not mutate its arguments.
  *
- * **Example** (multiplication with short-circuit)
+ * **Example** (Multiplication with short-circuit)
  *
  * ```ts
  * import { Reducer } from "effect"
@@ -181,12 +188,14 @@ export function make<A>(
 /**
  * Reverses the argument order of a reducer's `combine` method.
  *
- * When to use:
+ * **When to use**
+ *
  * - You need the "right" value to act as the accumulator side.
  * - You want to reverse the natural direction of a non-commutative reducer
  *   (e.g. string concatenation becomes prepend).
  *
- * Behavior:
+ * **Details**
+ *
  * - Returns a new `Reducer` where `combine(self, that)` calls the original
  *   reducer as `combine(that, self)`.
  * - The `initialValue` is preserved from the original reducer.
@@ -194,7 +203,7 @@ export function make<A>(
  *   default left-to-right fold), not carried over from the original.
  * - Does not mutate the input reducer.
  *
- * **Example** (reversing string concatenation)
+ * **Example** (Reversing string concatenation)
  *
  * ```ts
  * import { Reducer, String } from "effect"

package/src/Ref.ts

@@ -42,9 +42,10 @@ const TypeId = "~effect/Ref"
 /**
  * A mutable reference that provides atomic read, write, and update operations.
  *
- * Ref is a thread-safe mutable reference type that allows for atomic operations
- * on shared state. It supports both simple read/write operations and complex
- * atomic transformations.
+ * **Details**
+ *
+ * A `Ref` is a thread-safe mutable reference type for shared state. It supports
+ * simple read and write operations as well as atomic transformations.
  *
  * **Example** (Reading and updating a ref)
  *
@@ -126,8 +127,14 @@ const RefProto = {
 /**
  * Creates a new Ref with the specified initial value (unsafe version).
  *
- * This function creates a Ref synchronously without wrapping in Effect.
- * Use this only when you're sure about the safety of immediate creation.
+ * **When to use**
+ *
+ * Use this when you need immediate synchronous construction and can guarantee
+ * that creating the `Ref` outside of `Effect` is safe.
+ *
+ * **Gotchas**
+ *
+ * Prefer `Ref.make` for Effect-wrapped creation in Effect programs.
  *
  * **Example** (Creating a ref unsafely)
  *
@@ -281,9 +288,7 @@ export const set = dual<
 >(2, <A>(self: Ref<A>, value: A) => Effect.sync(() => MutableRef.set(self.ref, value)))
 
 /**
- * Atomically gets the current value of the Ref and sets it to the specified value.
- *
- * Returns the value that was in the Ref before the update.
+ * Atomically gets the current value of the Ref, sets it to the specified value, and returns the previous value.
  *
  * **Example** (Replacing a value atomically)
  *
@@ -307,9 +312,7 @@ export const set = dual<
  */
 export const getAndSet = dual<
   /**
-   * Atomically gets the current value of the Ref and sets it to the specified value.
-   *
-   * Returns the value that was in the Ref before the update.
+   * Atomically gets the current value of the Ref, sets it to the specified value, and returns the previous value.
    *
    * **Example** (Replacing a value atomically)
    *
@@ -333,9 +336,7 @@ export const getAndSet = dual<
    */
   <A>(value: A) => (self: Ref<A>) => Effect.Effect<A>,
   /**
-   * Atomically gets the current value of the Ref and sets it to the specified value.
-   *
-   * Returns the value that was in the Ref before the update.
+   * Atomically gets the current value of the Ref, sets it to the specified value, and returns the previous value.
    *
    * **Example** (Replacing a value atomically)
    *
@@ -366,9 +367,7 @@ export const getAndSet = dual<
   }))
 
 /**
- * Atomically gets the current value of the Ref and updates it with the given function.
- *
- * Returns the value that was in the Ref before the update.
+ * Atomically gets the current value of the Ref, updates it with the given function, and returns the previous value.
  *
  * **Example** (Updating and returning the previous value)
  *
@@ -392,9 +391,7 @@ export const getAndSet = dual<
  */
 export const getAndUpdate = dual<
   /**
-   * Atomically gets the current value of the Ref and updates it with the given function.
-   *
-   * Returns the value that was in the Ref before the update.
+   * Atomically gets the current value of the Ref, updates it with the given function, and returns the previous value.
    *
    * **Example** (Updating and returning the previous value)
    *
@@ -418,9 +415,7 @@ export const getAndUpdate = dual<
    */
   <A>(f: (a: A) => A) => (self: Ref<A>) => Effect.Effect<A>,
   /**
-   * Atomically gets the current value of the Ref and updates it with the given function.
-   *
-   * Returns the value that was in the Ref before the update.
+   * Atomically gets the current value of the Ref, updates it with the given function, and returns the previous value.
    *
    * **Example** (Updating and returning the previous value)
    *
@@ -453,9 +448,11 @@ export const getAndUpdate = dual<
 /**
  * Atomically gets the current value of the Ref and updates it with the given partial function.
  *
- * If the partial function returns `Option.some`, the Ref is updated with the new value.
- * If it returns `Option.none`, the Ref is left unchanged.
- * Always returns the value that was in the Ref before the attempted update.
+ * **Details**
+ *
+ * If the partial function returns `Option.some`, the Ref is updated with the
+ * new value. If it returns `Option.none`, the Ref is left unchanged. The effect
+ * always returns the value that was in the Ref before the attempted update.
  *
  * **Example** (Conditionally updating and returning the previous value)
  *
@@ -494,9 +491,11 @@ export const getAndUpdateSome = dual<
   /**
    * Atomically gets the current value of the Ref and updates it with the given partial function.
    *
-   * If the partial function returns `Option.some`, the Ref is updated with the new value.
-   * If it returns `Option.none`, the Ref is left unchanged.
-   * Always returns the value that was in the Ref before the attempted update.
+   * **Details**
+   *
+   * If the partial function returns `Option.some`, the Ref is updated with the
+   * new value. If it returns `Option.none`, the Ref is left unchanged. The effect
+   * always returns the value that was in the Ref before the attempted update.
    *
    * **Example** (Conditionally updating and returning the previous value)
    *
@@ -535,9 +534,11 @@ export const getAndUpdateSome = dual<
   /**
    * Atomically gets the current value of the Ref and updates it with the given partial function.
    *
-   * If the partial function returns `Option.some`, the Ref is updated with the new value.
-   * If it returns `Option.none`, the Ref is left unchanged.
-   * Always returns the value that was in the Ref before the attempted update.
+   * **Details**
+   *
+   * If the partial function returns `Option.some`, the Ref is updated with the
+   * new value. If it returns `Option.none`, the Ref is left unchanged. The effect
+   * always returns the value that was in the Ref before the attempted update.
    *
    * **Example** (Conditionally updating and returning the previous value)
    *
@@ -586,7 +587,10 @@ export const getAndUpdateSome = dual<
 /**
  * Atomically sets the value of the Ref to the specified value and returns the new value.
  *
- * This is useful when you want to set a value and immediately get it back in one atomic operation.
+ * **When to use**
+ *
+ * Use this when you want to set a value and immediately get it back in one
+ * atomic operation.
  *
  * **Example** (Setting and returning the new value)
  *
@@ -621,7 +625,10 @@ export const setAndGet = dual<
   /**
    * Atomically sets the value of the Ref to the specified value and returns the new value.
    *
-   * This is useful when you want to set a value and immediately get it back in one atomic operation.
+   * **When to use**
+   *
+   * Use this when you want to set a value and immediately get it back in one
+   * atomic operation.
    *
    * **Example** (Setting and returning the new value)
    *
@@ -656,7 +663,10 @@ export const setAndGet = dual<
   /**
    * Atomically sets the value of the Ref to the specified value and returns the new value.
    *
-   * This is useful when you want to set a value and immediately get it back in one atomic operation.
+   * **When to use**
+   *
+   * Use this when you want to set a value and immediately get it back in one
+   * atomic operation.
    *
    * **Example** (Setting and returning the new value)
    *
@@ -693,8 +703,11 @@ export const setAndGet = dual<
 /**
  * Atomically modifies the value of the Ref using the given function.
  *
- * The function receives the current value and returns a tuple of [result, newValue].
- * The Ref is updated with the newValue and the result is returned.
+ * **Details**
+ *
+ * The function receives the current value and returns a tuple of
+ * `[result, newValue]`. The Ref is updated with `newValue`, and `result` is
+ * returned by the effect.
  *
  * **Example** (Modifying a value atomically)
  *
@@ -736,8 +749,11 @@ export const modify = dual<
   /**
    * Atomically modifies the value of the Ref using the given function.
    *
-   * The function receives the current value and returns a tuple of [result, newValue].
-   * The Ref is updated with the newValue and the result is returned.
+   * **Details**
+   *
+   * The function receives the current value and returns a tuple of
+   * `[result, newValue]`. The Ref is updated with `newValue`, and `result` is
+   * returned by the effect.
    *
    * **Example** (Modifying a value atomically)
    *
@@ -779,8 +795,11 @@ export const modify = dual<
   /**
    * Atomically modifies the value of the Ref using the given function.
    *
-   * The function receives the current value and returns a tuple of [result, newValue].
-   * The Ref is updated with the newValue and the result is returned.
+   * **Details**
+   *
+   * The function receives the current value and returns a tuple of
+   * `[result, newValue]`. The Ref is updated with `newValue`, and `result` is
+   * returned by the effect.
    *
    * **Example** (Modifying a value atomically)
    *
@@ -1271,8 +1290,10 @@ export const updateAndGet = dual<
 /**
  * Atomically updates the value of the Ref using the given partial function.
  *
- * If the partial function returns `Option.some`, the Ref is updated with the new value.
- * If it returns `Option.none`, the Ref is left unchanged.
+ * **Details**
+ *
+ * If the partial function returns `Option.some`, the Ref is updated with the
+ * new value. If it returns `Option.none`, the Ref is left unchanged.
  *
  * **Example** (Conditionally updating a value)
  *
@@ -1310,8 +1331,10 @@ export const updateSome = dual<
   /**
    * Atomically updates the value of the Ref using the given partial function.
    *
-   * If the partial function returns `Option.some`, the Ref is updated with the new value.
-   * If it returns `Option.none`, the Ref is left unchanged.
+   * **Details**
+   *
+   * If the partial function returns `Option.some`, the Ref is updated with the
+   * new value. If it returns `Option.none`, the Ref is left unchanged.
    *
    * **Example** (Conditionally updating a value)
    *
@@ -1349,8 +1372,10 @@ export const updateSome = dual<
   /**
    * Atomically updates the value of the Ref using the given partial function.
    *
-   * If the partial function returns `Option.some`, the Ref is updated with the new value.
-   * If it returns `Option.none`, the Ref is left unchanged.
+   * **Details**
+   *
+   * If the partial function returns `Option.some`, the Ref is updated with the
+   * new value. If it returns `Option.none`, the Ref is left unchanged.
    *
    * **Example** (Conditionally updating a value)
    *
@@ -1396,9 +1421,11 @@ export const updateSome = dual<
 /**
  * Atomically updates the value of the Ref using the given partial function and returns the current value.
  *
- * If the partial function returns `Option.some`, the Ref is updated with the new value.
- * If it returns `Option.none`, the Ref is left unchanged.
- * Returns the current value of the Ref after the potential update.
+ * **Details**
+ *
+ * If the partial function returns `Option.some`, the Ref is updated with the
+ * new value. If it returns `Option.none`, the Ref is left unchanged. The effect
+ * returns the current value of the Ref after the potential update.
  *
  * **Example** (Conditionally updating and returning the current value)
  *
@@ -1431,9 +1458,11 @@ export const updateSomeAndGet = dual<
   /**
    * Atomically updates the value of the Ref using the given partial function and returns the current value.
    *
-   * If the partial function returns `Option.some`, the Ref is updated with the new value.
-   * If it returns `Option.none`, the Ref is left unchanged.
-   * Returns the current value of the Ref after the potential update.
+   * **Details**
+   *
+   * If the partial function returns `Option.some`, the Ref is updated with the
+   * new value. If it returns `Option.none`, the Ref is left unchanged. The effect
+   * returns the current value of the Ref after the potential update.
    *
    * **Example** (Conditionally updating and returning the current value)
    *
@@ -1466,9 +1495,11 @@ export const updateSomeAndGet = dual<
   /**
    * Atomically updates the value of the Ref using the given partial function and returns the current value.
    *
-   * If the partial function returns `Option.some`, the Ref is updated with the new value.
-   * If it returns `Option.none`, the Ref is left unchanged.
-   * Returns the current value of the Ref after the potential update.
+   * **Details**
+   *
+   * If the partial function returns `Option.some`, the Ref is updated with the
+   * new value. If it returns `Option.none`, the Ref is left unchanged. The effect
+   * returns the current value of the Ref after the potential update.
    *
    * **Example** (Conditionally updating and returning the current value)
    *
@@ -1510,8 +1541,14 @@ export const updateSomeAndGet = dual<
 /**
  * Gets the current value of the Ref synchronously (unsafe version).
  *
- * This function reads the current value without wrapping in Effect.
- * Use this only when you're sure about the safety of immediate access.
+ * **When to use**
+ *
+ * Use this when you need immediate synchronous access and can guarantee that
+ * reading the `Ref` outside of `Effect` is safe.
+ *
+ * **Gotchas**
+ *
+ * Prefer `Ref.get` for Effect-wrapped access in Effect programs.
  *
  * **Example** (Reading a ref unsafely)
  *

package/src/References.ts

@@ -21,31 +21,43 @@ import { CurrentTraceLevel, DisablePropagation, MinimumTraceLevel, type SpanLink
 
 export {
   /**
+   * Reference for the current trace level used for dynamic trace filtering.
+   *
    * @category references
    * @since 4.0.0
    */
   CurrentTraceLevel,
   /**
+   * Reference used to disable trace propagation in the current context.
+   *
    * @category references
    * @since 4.0.0
    */
   DisablePropagation,
   /**
+   * Reference controlling the maximum operation budget before a fiber yields to the scheduler.
+   *
    * @category references
    * @since 4.0.0
    */
   MaxOpsBeforeYield,
   /**
+   * Reference setting the minimum trace level threshold for span sampling.
+   *
    * @category references
    * @since 4.0.0
    */
   MinimumTraceLevel,
   /**
+   * Reference controlling whether the runtime bypasses scheduler yield checks.
+   *
    * @category references
    * @since 4.0.0
    */
   PreventSchedulerYield,
   /**
+   * Reference for the active tracer service used to create spans.
+   *
    * @category references
    * @since 4.0.0
    */
@@ -155,7 +167,8 @@ export const CurrentLogAnnotations: Context.Reference<ReadonlyRecord<string, unk
  * Reference for the current log severity used by `Effect.log` when no explicit
  * level is provided.
  *
- * **Notes**
+ * **Details**
+ *
  * Use `MinimumLogLevel` to control which log entries are filtered out.
  *
  * **Example** (Changing the current log level)
@@ -266,6 +279,7 @@ export const CurrentLogSpans: Context.Reference<ReadonlyArray<[label: string, ti
  * fiber.
  *
  * **Details**
+ *
  * Effect and Layer tracing use this reference to attach stack-frame information
  * to failures and interruption causes. It is normally managed by tracing APIs
  * rather than provided directly by application code.
@@ -548,6 +562,7 @@ export const UnhandledLogLevel: Context.Reference<Severity | undefined> = refere
  * A captured stack-frame node used to describe the traced execution path.
  *
  * **Details**
+ *
  * Each frame has a span or operation `name`, a lazy `stack` supplier, and an
  * optional `parent` frame that links it to the previous captured frame.
  *
@@ -565,6 +580,7 @@ export interface StackFrame {
  * operations.
  *
  * **Details**
+ *
  * Providing this reference changes which `Logger` instances receive log entries
  * in the current context.
  *
@@ -577,6 +593,7 @@ export const CurrentLoggers: Context.Reference<ReadonlySet<Logger<unknown, any>>
  * Reference controlling whether the default console logger writes to stderr.
  *
  * **Details**
+ *
  * When set to `true`, the pretty console logger uses `console.error`; otherwise
  * it uses `console.log`.
  *