Skip to content

Commit

Permalink
docs: fix grammar
Browse files Browse the repository at this point in the history
  • Loading branch information
kgryte committed Jan 1, 2024
1 parent 36548cd commit 4007945
Show file tree
Hide file tree
Showing 7 changed files with 12 additions and 12 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ limitations under the License.

# bifurcateIndicesBy

> Split element indices into two groups according to an predicate function.
> Split element indices into two groups according to a predicate function.
<!-- Section to include introductory text. Make sure to keep an empty line after the intro `section` element and another before the `/section` close. -->

Expand All @@ -42,7 +42,7 @@ var bifurcateIndicesBy = require( '@stdlib/array/base/bifurcate-indices-by' );

#### bifurcateIndicesBy( x, predicate\[, thisArg] )

Splits element indices into two groups according to an predicate function.
Splits element indices into two groups according to a predicate function.

```javascript
function predicate( v ) {
Expand All @@ -55,7 +55,7 @@ var out = bifurcateIndicesBy( x, predicate );
// returns [ [ 0, 1, 3 ], [ 2 ] ]
```

An `predicate` function is provided the following arguments:
A `predicate` function is provided the following arguments:

- **value**: current array element.
- **index**: current array element index.
Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@

{{alias}}( x, predicate[, thisArg] )
Splits element indices into two groups according to an predicate function.
Splits element indices into two groups according to a predicate function.

When invoked, the predicate function is provided the following arguments:

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -72,7 +72,7 @@ type Predicate<T, U> = Nullary<U> | Unary<T, U> | Binary<T, U> | Ternary<T, U>;
type IndicesResults<T> = [ Array<T>, Array<T> ];

/**
* Splits element indices into two groups according to an predicate function.
* Splits element indices into two groups according to a predicate function.
*
* ## Notes
*
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@
'use strict';

/**
* Split element indices into two groups according to an predicate function.
* Split element indices into two groups according to a predicate function.
*
* @module @stdlib/array/base/bifurcate-indices-by
*
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@ var resolveGetter = require( '@stdlib/array/base/resolve-getter' );
// MAIN //

/**
* Splits element indices into two groups according to an predicate function.
* Splits element indices into two groups according to a predicate function.
*
* @param {Collection} x - input array
* @param {Function} predicate - predicate function specifying which group an element in the input collection belongs to
Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
{
"name": "@stdlib/array/base/bifurcate-indices-by",
"version": "0.0.0",
"description": "Split element indices into two groups according to an predicate function.",
"description": "Split element indices into two groups according to a predicate function.",
"license": "Apache-2.0",
"author": {
"name": "The Stdlib Authors",
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@ tape( 'main export is a function', function test( t ) {
t.end();
});

tape( 'the function splits array element indices into two groups according to an predicate function', function test( t ) {
tape( 'the function splits array element indices into two groups according to a predicate function', function test( t ) {
var expected;
var out;
var x;
Expand All @@ -55,7 +55,7 @@ tape( 'the function splits array element indices into two groups according to an
}
});

tape( 'the function splits array element indices into two groups according to an predicate function (typed arrays)', function test( t ) {
tape( 'the function splits array element indices into two groups according to a predicate function (typed arrays)', function test( t ) {
var expected;
var out;
var x;
Expand All @@ -76,7 +76,7 @@ tape( 'the function splits array element indices into two groups according to an
}
});

tape( 'the function splits array element indices into two groups according to an predicate function (array-like objects)', function test( t ) {
tape( 'the function splits array element indices into two groups according to a predicate function (array-like objects)', function test( t ) {
var expected;
var out;
var x;
Expand All @@ -103,7 +103,7 @@ tape( 'the function splits array element indices into two groups according to an
}
});

tape( 'the function splits array element indices into two groups according to an predicate function (accessor arrays)', function test( t ) {
tape( 'the function splits array element indices into two groups according to a predicate function (accessor arrays)', function test( t ) {
var expected;
var out;
var x;
Expand Down

1 comment on commit 4007945

@stdlib-bot
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Coverage Report

Package Statements Branches Functions Lines
array/base/bifurcate-entries-by $\color{green}123/123$
$\color{green}+100.00\%$
$\color{green}9/9$
$\color{green}+100.00\%$
$\color{green}1/1$
$\color{green}+100.00\%$
$\color{green}123/123$
$\color{green}+100.00\%$
array/base/bifurcate-indices-by $\color{green}121/121$
$\color{green}+100.00\%$
$\color{green}9/9$
$\color{green}+100.00\%$
$\color{green}1/1$
$\color{green}+100.00\%$
$\color{green}121/121$
$\color{green}+100.00\%$
array/base/bifurcate-values-by $\color{green}123/123$
$\color{green}+100.00\%$
$\color{green}9/9$
$\color{green}+100.00\%$
$\color{green}1/1$
$\color{green}+100.00\%$
$\color{green}123/123$
$\color{green}+100.00\%$

The above coverage report was generated for the changes in this push.

Please sign in to comment.