From f3ef3f50160e0ca31f210cd10a8b701d5a40c1eb Mon Sep 17 00:00:00 2001 From: Claude Date: Sun, 31 May 2026 00:19:26 +0000 Subject: [PATCH 1/4] docs: document early-return behavior in `@stdlib/iter/any` Populate the previously empty `
` block in the README to describe the short-circuit return upon encountering a truthy iterated value. 54/65 (83%) of sibling `iter/*` packages populate this section, and `docs/repl.txt` already documents the same behavior with identical wording. The corresponding `iter/any-by` README documents the analogous predicate-driven behavior. --- lib/node_modules/@stdlib/iter/any/README.md | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/lib/node_modules/@stdlib/iter/any/README.md b/lib/node_modules/@stdlib/iter/any/README.md index dca159884b33..d8f3a0d7feea 100644 --- a/lib/node_modules/@stdlib/iter/any/README.md +++ b/lib/node_modules/@stdlib/iter/any/README.md @@ -70,6 +70,10 @@ var bool = iterAny( array2iterator( [] ) );
+## Notes + +- The function immediately returns upon encountering a truthy value. +
From 55924047116bdaa4fb04c83f09618a60faddc696 Mon Sep 17 00:00:00 2001 From: Claude Date: Sun, 31 May 2026 00:19:31 +0000 Subject: [PATCH 2/4] docs: document early-return behavior in `@stdlib/iter/every` Populate the previously empty `
` block in the README to describe the short-circuit return upon encountering a falsy iterated value. 54/65 (83%) of sibling `iter/*` packages populate this section, and `docs/repl.txt` already documents the same behavior with identical wording. The corresponding `iter/every-by` README documents the analogous predicate-driven behavior. --- lib/node_modules/@stdlib/iter/every/README.md | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/lib/node_modules/@stdlib/iter/every/README.md b/lib/node_modules/@stdlib/iter/every/README.md index ce4002d9ac4f..969d71f3e01b 100644 --- a/lib/node_modules/@stdlib/iter/every/README.md +++ b/lib/node_modules/@stdlib/iter/every/README.md @@ -70,6 +70,10 @@ var bool = iterEvery( array2iterator( [] ) );
+## Notes + +- The function immediately returns upon encountering a falsy value. +
From b8e20427565843eec986aca9e69c2efe51e0dcba Mon Sep 17 00:00:00 2001 From: Claude Date: Sun, 31 May 2026 00:19:35 +0000 Subject: [PATCH 3/4] docs: document early-return behavior in `@stdlib/iter/none` Populate the previously empty `
` block in the README to describe the short-circuit return upon encountering a truthy iterated value. 54/65 (83%) of sibling `iter/*` packages populate this section, and `docs/repl.txt` already documents the same behavior with identical wording. The corresponding `iter/none-by` README documents the analogous predicate-driven behavior. --- lib/node_modules/@stdlib/iter/none/README.md | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/lib/node_modules/@stdlib/iter/none/README.md b/lib/node_modules/@stdlib/iter/none/README.md index 79573295e9fd..20e2d6a84361 100644 --- a/lib/node_modules/@stdlib/iter/none/README.md +++ b/lib/node_modules/@stdlib/iter/none/README.md @@ -70,6 +70,10 @@ var bool = iterNone( array2iterator( [] ) );
+## Notes + +- The function immediately returns upon encountering a truthy value. +
From 85aa41dcf870975f6f8ccbef5991c636ddee8380 Mon Sep 17 00:00:00 2001 From: Claude Date: Sun, 31 May 2026 00:19:40 +0000 Subject: [PATCH 4/4] docs: document early-return behavior in `@stdlib/iter/some` Populate the previously empty `
` block in the README to describe the short-circuit return upon finding `n` truthy iterated values. 54/65 (83%) of sibling `iter/*` packages populate this section, and `docs/repl.txt` already documents the same behavior with identical wording. The corresponding `iter/some-by` README documents the analogous predicate-driven behavior. --- lib/node_modules/@stdlib/iter/some/README.md | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/lib/node_modules/@stdlib/iter/some/README.md b/lib/node_modules/@stdlib/iter/some/README.md index 77da1954955e..4fe7c23c9051 100644 --- a/lib/node_modules/@stdlib/iter/some/README.md +++ b/lib/node_modules/@stdlib/iter/some/README.md @@ -70,6 +70,10 @@ var bool = iterSome( array2iterator( [] ), 1 );
+## Notes + +- The function immediately returns upon finding `n` truthy values. +