Skip to content

Commit e506e10

Browse files
committed
docs: fix spelling
1 parent 1a62e75 commit e506e10

File tree

42 files changed

+97
-91
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

42 files changed

+97
-91
lines changed

lib/node_modules/@stdlib/stats/array/midrange-by/README.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -20,11 +20,11 @@ limitations under the License.
2020

2121
# midrangeBy
2222

23-
> Calculate the [midrange][midrange] of an array via a callback function.
23+
> Calculate the [mid-range][mid-range] of an array via a callback function.
2424
2525
<section class="intro">
2626

27-
The [**midrange**][midrange] is defined as the arithmetic mean of the maximum and minimum values.
27+
The [**mid-range**][mid-range] is defined as the arithmetic mean of the maximum and minimum values.
2828

2929
</section>
3030

@@ -40,7 +40,7 @@ var midrangeBy = require( '@stdlib/stats/array/midrange-by' );
4040

4141
#### midrangeBy( x, clbk\[, thisArg] )
4242

43-
Computes the [midrange][midrange] of an array via a callback function.
43+
Computes the [mid-range][mid-range] of an array via a callback function.
4444

4545
```javascript
4646
function accessor( v ) {
@@ -144,7 +144,7 @@ console.log( v );
144144

145145
[@stdlib/array/base/accessor]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/array/base/accessor
146146

147-
[midrange]: https://en.wikipedia.org/wiki/Mid-range
147+
[mid-range]: https://en.wikipedia.org/wiki/Mid-range
148148

149149
</section>
150150

lib/node_modules/@stdlib/stats/array/midrange-by/docs/repl.txt

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11

22
{{alias}}( x, clbk[, thisArg] )
3-
Computes the midrange of an array via a callback function.
3+
Computes the mid-range of an array via a callback function.
44

55
If provided an empty array, the function returns `NaN`.
66

@@ -29,7 +29,7 @@
2929
Returns
3030
-------
3131
out: number
32-
Midrange.
32+
Mid-range.
3333

3434
Examples
3535
--------

lib/node_modules/@stdlib/stats/array/midrange-by/docs/types/index.d.ts

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -72,12 +72,12 @@ type Ternary<T, U, ThisArg> = ( this: ThisArg, value: T, index: number, array: U
7272
type Callback<T, U, ThisArg> = Nullary<ThisArg> | Unary<T, ThisArg> | Binary<T, ThisArg> | Ternary<T, U, ThisArg>;
7373

7474
/**
75-
* Computes the midrange of an array via a callback function.
75+
* Computes the mid-range of an array via a callback function.
7676
*
7777
* @param x - input array
7878
* @param clbk - callback
7979
* @param thisArg - execution context
80-
* @returns midrange
80+
* @returns mid-range
8181
*
8282
* @example
8383
* var x = [ -2.0, 1.0, 3.0, -5.0, 4.0, 0.0, -1.0, -3.0 ];

lib/node_modules/@stdlib/stats/array/midrange-by/lib/index.js

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@
1919
'use strict';
2020

2121
/**
22-
* Compute the midrange of an array via a callback function.
22+
* Compute the mid-range of an array via a callback function.
2323
*
2424
* @module @stdlib/stats/array/midrange-by
2525
*

lib/node_modules/@stdlib/stats/array/midrange-by/lib/main.js

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -29,14 +29,14 @@ var format = require( '@stdlib/string/format' );
2929
// MAIN //
3030

3131
/**
32-
* Computes the midrange of an array via a callback function.
32+
* Computes the mid-range of an array via a callback function.
3333
*
3434
* @param {Collection} x - input array
3535
* @param {Callback} clbk - callback
3636
* @param {*} [thisArg] - execution context
3737
* @throws {TypeError} first argument must be an array-like object
3838
* @throws {TypeError} second argument must be a function
39-
* @returns {number} midrange
39+
* @returns {number} mid-range
4040
*
4141
* @example
4242
* var x = [ -2.0, 1.0, 3.0, -5.0, 4.0, 0.0, -1.0, -3.0 ];

lib/node_modules/@stdlib/stats/array/midrange-by/package.json

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
{
22
"name": "@stdlib/stats/array/midrange-by",
33
"version": "0.0.0",
4-
"description": "Calculate the midrange of an array via a callback function.",
4+
"description": "Calculate the mid-range of an array via a callback function.",
55
"license": "Apache-2.0",
66
"author": {
77
"name": "The Stdlib Authors",
@@ -60,6 +60,7 @@
6060
"minimum",
6161
"min",
6262
"midrange",
63+
"mid-range",
6364
"range",
6465
"extremes",
6566
"dispersion",

lib/node_modules/@stdlib/stats/array/midrange-by/test/test.js

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -113,7 +113,7 @@ tape( 'the function throws an error if provided a second argument which is not a
113113
}
114114
});
115115

116-
tape( 'the function calculates the midrange of an array via a callback function', function test( t ) {
116+
tape( 'the function calculates the mid-range of an array via a callback function', function test( t ) {
117117
var x;
118118
var v;
119119

@@ -140,7 +140,7 @@ tape( 'the function calculates the midrange of an array via a callback function'
140140
t.end();
141141
});
142142

143-
tape( 'the function calculates the midrange of an array via a callback function (accessors)', function test( t ) {
143+
tape( 'the function calculates the mid-range of an array via a callback function (accessors)', function test( t ) {
144144
var x;
145145
var v;
146146

@@ -167,7 +167,7 @@ tape( 'the function calculates the midrange of an array via a callback function
167167
t.end();
168168
});
169169

170-
tape( 'the function calculates the midrange of an array (array-like object)', function test( t ) {
170+
tape( 'the function calculates the mid-range of an array (array-like object)', function test( t ) {
171171
var x;
172172
var v;
173173

lib/node_modules/@stdlib/stats/array/midrange/README.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -20,11 +20,11 @@ limitations under the License.
2020

2121
# midrange
2222

23-
> Calculate the [midrange][midrange] of an array.
23+
> Calculate the [mid-range][mid-range] of an array.
2424
2525
<section class="intro">
2626

27-
The [**midrange**][midrange] is defined as the arithmetic mean of the maximum and minimum values in a data set. The measure is the midpoint of the range and a measure of central tendency.
27+
The [**mid-range**][mid-range] is defined as the arithmetic mean of the maximum and minimum values in a data set. The measure is the midpoint of the range and a measure of central tendency.
2828

2929
</section>
3030

@@ -40,7 +40,7 @@ var midrange = require( '@stdlib/stats/array/midrange' );
4040

4141
#### midrange( x )
4242

43-
Computes the [midrange][midrange] of an array.
43+
Computes the [mid-range][mid-range] of an array.
4444

4545
```javascript
4646
var x = [ 1.0, -2.0, 2.0 ];
@@ -103,7 +103,7 @@ console.log( v );
103103

104104
<section class="links">
105105

106-
[midrange]: https://en.wikipedia.org/wiki/Mid-range
106+
[mid-range]: https://en.wikipedia.org/wiki/Mid-range
107107

108108
[@stdlib/array/base/accessor]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/array/base/accessor
109109

lib/node_modules/@stdlib/stats/array/midrange/docs/repl.txt

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11

22
{{alias}}( x )
3-
Computes the midrange of an array.
3+
Computes the mid-range of an array.
44

55
If provided an empty array, the function returns `NaN`.
66

@@ -12,7 +12,7 @@
1212
Returns
1313
-------
1414
out: number
15-
Midrange.
15+
Mid-range.
1616

1717
Examples
1818
--------

lib/node_modules/@stdlib/stats/array/midrange/docs/types/index.d.ts

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -28,10 +28,10 @@ import { NumericArray, Collection, AccessorArrayLike } from '@stdlib/types/array
2828
type InputArray = NumericArray | Collection<number> | AccessorArrayLike<number>;
2929

3030
/**
31-
* Computes the midrange of an array.
31+
* Computes the mid-range of an array.
3232
*
3333
* @param x - input array
34-
* @returns midrange
34+
* @returns mid-range
3535
*
3636
* @example
3737
* var x = [ 1.0, -2.0, 2.0 ];

0 commit comments

Comments
 (0)