effect 4.0.0-beta.73 → 4.0.0-beta.75

package/src/Path.ts

@@ -216,7 +216,7 @@ export declare namespace Path {
  *
  * **When to use**
  *
- * Use when an effect needs path operations supplied by its environment.
+ * Use when you need path operations supplied by an effect's environment.
  *
  * **Example** (Providing a custom Path service)
  *
@@ -274,7 +274,7 @@ export declare namespace Path {
  * const result = Effect.provide(program, customPathLayer)
  * ```
  *
- * @category tag
+ * @category services
  * @since 4.0.0
  */
 export const Path: Context.Service<Path, Path> = Context.Service("effect/Path")
@@ -876,7 +876,7 @@ const posixImpl = Path.of({
  *
  * **When to use**
  *
- * Use when an effect requires the `Path` service and should run with the
+ * Use when you need an effect that requires the `Path` service to run with the
  * built-in POSIX path implementation.
  *
  * **Details**

package/src/Pipeable.ts

@@ -568,7 +568,7 @@ export interface Pipeable {
  * console.log(result) // 21
  * ```
  *
- * @category utils
+ * @category combinators
  * @since 2.0.0
  */
 export const pipeArguments = <A>(self: A, args: IArguments): unknown => {
@@ -626,8 +626,8 @@ export const Prototype: Pipeable = {
  *
  * **When to use**
  *
- * Use when extend or compose this constructor when defining a class that should support
- * Effect-style method chaining through `.pipe(...)`.
+ * Use when you need to define a class that supports Effect-style method
+ * chaining through `.pipe(...)`.
  *
  * @category constructors
  * @since 3.15.0

package/src/PlatformError.ts

@@ -40,8 +40,8 @@ const TypeId = "~effect/platform/PlatformError"
  *
  * **When to use**
  *
- * Use when a platform API rejects caller input before performing the underlying
- * operation and callers need invalid-argument reason data directly.
+ * Use when you need to model caller input rejected before a platform operation
+ * runs, including invalid-argument reason data.
  *
  * **Details**
  *
@@ -112,8 +112,8 @@ export type SystemErrorTag =
  *
  * **When to use**
  *
- * Use as the reason data for failures reported by a host platform or operating
- * system when you need a normalized system error tag plus operation details.
+ * Use when you need normalized reason data for a platform or system operation
+ * failure, including the operation details.
  *
  * **Details**
  *

package/src/Pool.ts

@@ -230,8 +230,7 @@ export const isPool = (u: unknown): u is Pool<unknown, unknown> => hasProperty(u
  *
  * **When to use**
  *
- * Use to create a fixed-size pool when you know the exact number of resources
- * needed upfront, without growth or shrinkage.
+ * Use when you need a fixed-size pool with no growth or shrinkage.
  *
  * **Details**
  *
@@ -530,9 +529,8 @@ const getPoolItemInner = Effect.fnUntraced(function*<A, E>(
  *
  * **When to use**
  *
- * Use to prevent a pooled item from being reused after you determine it is no
- * longer suitable, such as a stale connection or a resource that failed a
- * health check.
+ * Use to prevent a pooled item from being reused after it becomes unsuitable,
+ * such as a stale connection or a resource that failed a health check.
  *
  * **Gotchas**
  *
@@ -551,9 +549,8 @@ export const invalidate: {
    *
    * **When to use**
    *
-   * Use to prevent a pooled item from being reused after you determine it is no
-   * longer suitable, such as a stale connection or a resource that failed a
-   * health check.
+   * Use to prevent a pooled item from being reused after it becomes unsuitable,
+   * such as a stale connection or a resource that failed a health check.
    *
    * **Gotchas**
    *
@@ -572,9 +569,8 @@ export const invalidate: {
    *
    * **When to use**
    *
-   * Use to prevent a pooled item from being reused after you determine it is no
-   * longer suitable, such as a stale connection or a resource that failed a
-   * health check.
+   * Use to prevent a pooled item from being reused after it becomes unsuitable,
+   * such as a stale connection or a resource that failed a health check.
    *
    * **Gotchas**
    *