From 9ac58530e53fe1c7657b2f000dc3206c9a855035 Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Sat, 21 Sep 2024 21:28:15 +0000 Subject: [PATCH] Auto-generated commit --- CHANGELOG.md | 3 ++- CONTRIBUTORS | 1 + docs/repl.txt | 10 +++++----- 3 files changed, 8 insertions(+), 6 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index b115fb4..cc7de73 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -4,7 +4,7 @@
-## Unreleased (2024-09-17) +## Unreleased (2024-09-21)
@@ -12,6 +12,7 @@
+- [`6e9f42e`](https://github.com/stdlib-js/stdlib/commit/6e9f42e4c912485d9896eaa16c88b70fd3688e97) - **docs:** harmonize list formatting in repl.txt and ensure starting newline _(by Philipp Burckhardt)_ - [`cadb613`](https://github.com/stdlib-js/stdlib/commit/cadb6131d6ce50338d11757e88e8a910a0367983) - **chore:** update argument documentation styling _(by Philipp Burckhardt)_
diff --git a/CONTRIBUTORS b/CONTRIBUTORS index ecfde1e..147a89e 100644 --- a/CONTRIBUTORS +++ b/CONTRIBUTORS @@ -40,6 +40,7 @@ Joey Reed Jordan Gallivan <115050475+Jordan-Gallivan@users.noreply.github.com> Joris Labie Justin Dennison +Kaif Mohd Karthik Prakash <116057817+skoriop@users.noreply.github.com> Khaldon Krishnendu Das <86651039+itskdhere@users.noreply.github.com> diff --git a/docs/repl.txt b/docs/repl.txt index 7499f69..3a9b317 100644 --- a/docs/repl.txt +++ b/docs/repl.txt @@ -5,13 +5,13 @@ When invoked, the predicate function is provided two arguments: - - `path`: a resolved path - - `next`: a callback to be invoked after processing a resolved path + - path: a resolved path. + - next: a callback to be invoked after processing a resolved path. The `next` callback takes two arguments: - - `error`: error argument - - `result`: test result + - error: error argument. + - result: test result. If a provided predicate function calls the `next` callback with a truthy `error` argument, the function suspends execution and immediately calls the @@ -70,7 +70,7 @@ The predicate function is provided one argument: - - `path`: a resolved path + - path: a resolved path. The function immediately returns upon encountering a truthy return value.