Skip to content

Commit 38c0874

Browse files
committed
docs: apply suggestions from code review
--- type: pre_commit_static_analysis_report description: Results of running static analysis checks when committing changes. report: - task: lint_filenames status: passed - task: lint_editorconfig status: passed - task: lint_markdown status: passed - task: lint_package_json status: passed - task: lint_repl_help status: passed - task: lint_javascript_src status: passed - task: lint_javascript_cli status: na - task: lint_javascript_examples status: na - task: lint_javascript_tests status: na - task: lint_javascript_benchmarks status: na - task: lint_python status: na - task: lint_r status: na - task: lint_c_src status: na - task: lint_c_examples status: na - task: lint_c_benchmarks status: na - task: lint_c_tests_fixtures status: na - task: lint_shell status: na - task: lint_typescript_declarations status: passed - task: lint_typescript_tests status: passed - task: lint_license_headers status: passed ---
1 parent 4e641d7 commit 38c0874

6 files changed

Lines changed: 16 additions & 16 deletions

File tree

lib/node_modules/@stdlib/ndarray/flatten-from-by/README.md

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

2121
# flattenFromBy
2222

23-
> Flatten an [ndarray][@stdlib/ndarray/ctor] from a specified dimension while applying a callback function to each element.
23+
> Flatten an [ndarray][@stdlib/ndarray/ctor] according to a callback function starting from a specified dimension.
2424
2525
<section class="intro">
2626

@@ -38,7 +38,7 @@ var flattenFromBy = require( '@stdlib/ndarray/flatten-from-by' );
3838

3939
#### flattenFromBy( x, dim\[, options], fcn\[, thisArg] )
4040

41-
Flattens an [ndarray][@stdlib/ndarray/ctor] from a specified dimension while applying a callback function to each element.
41+
Flattens an [ndarray][@stdlib/ndarray/ctor] according to a callback function starting from a specified dimension.
4242

4343
```javascript
4444
var array = require( '@stdlib/ndarray/array' );

lib/node_modules/@stdlib/ndarray/flatten-from-by/docs/repl.txt

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

22
{{alias}}( x, dim[, options], fcn[, thisArg] )
3-
Flattens an ndarray from a specified dimension while applying a callback
4-
function to each element.
3+
Flattens an ndarray according to a callback function starting from a
4+
specified dimension.
55

66
Parameters
77
----------

lib/node_modules/@stdlib/ndarray/flatten-from-by/docs/types/index.d.ts

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -99,7 +99,7 @@ type Options<U> = BaseOptions & {
9999
};
100100

101101
/**
102-
* Flattens an ndarray from a specified dimension while applying a callback function to each element.
102+
* Flattens an ndarray according to a callback function starting from a specified dimension.
103103
*
104104
* @param x - input ndarray
105105
* @param dim - dimension to start flattening from
@@ -133,7 +133,7 @@ type Options<U> = BaseOptions & {
133133
declare function flattenFromBy<T extends typedndarray<number> = typedndarray<number>, ThisArg = unknown>( x: T, dim: number, fcn: Callback<number, T, number, ThisArg>, thisArg?: ThisParameterType<Callback<number, T, number, ThisArg>> ): T;
134134

135135
/**
136-
* Flattens an ndarray from a specified dimension while applying a callback function to each element.
136+
* Flattens an ndarray according to a callback function starting from a specified dimension.
137137
*
138138
* @param x - input ndarray
139139
* @param dim - dimension to start flattening from
@@ -164,7 +164,7 @@ declare function flattenFromBy<T extends typedndarray<number> = typedndarray<num
164164
declare function flattenFromBy<T extends ComplexLike = ComplexLike, U extends typedndarray<T> = typedndarray<T>, ThisArg = unknown>( x: U, dim: number, fcn: Callback<T, U, T, ThisArg>, thisArg?: ThisParameterType<Callback<T, U, T, ThisArg>> ): U;
165165

166166
/**
167-
* Flattens an ndarray from a specified dimension while applying a callback function to each element.
167+
* Flattens an ndarray according to a callback function starting from a specified dimension.
168168
*
169169
* @param x - input ndarray
170170
* @param dim - dimension to start flattening from
@@ -198,7 +198,7 @@ declare function flattenFromBy<T extends ComplexLike = ComplexLike, U extends ty
198198
declare function flattenFromBy<T extends typedndarray<boolean> = typedndarray<boolean>, ThisArg = unknown>( x: T, dim: number, fcn: Callback<boolean, T, boolean, ThisArg>, thisArg?: ThisParameterType<Callback<boolean, T, boolean, ThisArg>> ): T;
199199

200200
/**
201-
* Flattens an ndarray from a specified dimension while applying a callback function to each element.
201+
* Flattens an ndarray according to a callback function starting from a specified dimension.
202202
*
203203
* @param x - input ndarray
204204
* @param dim - dimension to start flattening from
@@ -231,7 +231,7 @@ declare function flattenFromBy<T extends typedndarray<boolean> = typedndarray<bo
231231
declare function flattenFromBy<T = unknown, U extends genericndarray<T> = genericndarray<T>, V = unknown, W extends genericndarray<V> = genericndarray<V>, ThisArg = unknown>( x: U, dim: number, fcn: Callback<T, U, V, ThisArg>, thisArg?: ThisParameterType<Callback<T, U, V, ThisArg>> ): W;
232232

233233
/**
234-
* Flattens an ndarray from a specified dimension while applying a callback function to each element.
234+
* Flattens an ndarray according to a callback function starting from a specified dimension.
235235
*
236236
* @param x - input ndarray
237237
* @param dim - dimension to start flattening from
@@ -272,7 +272,7 @@ declare function flattenFromBy<T = unknown, U extends genericndarray<T> = generi
272272
declare function flattenFromBy<T extends typedndarray<number> = typedndarray<number>, ThisArg = unknown>( x: T, dim: number, options: BaseOptions, fcn: Callback<number, T, number, ThisArg>, thisArg?: ThisParameterType<Callback<number, T, number, ThisArg>> ): T;
273273

274274
/**
275-
* Flattens an ndarray from a specified dimension while applying a callback function to each element.
275+
* Flattens an ndarray according to a callback function starting from a specified dimension.
276276
*
277277
* @param x - input ndarray
278278
* @param dim - dimension to start flattening from
@@ -310,7 +310,7 @@ declare function flattenFromBy<T extends typedndarray<number> = typedndarray<num
310310
declare function flattenFromBy<T extends ComplexLike = ComplexLike, U extends typedndarray<T> = typedndarray<T>, ThisArg = unknown>( x: U, dim: number, options: BaseOptions, fcn: Callback<T, U, T, ThisArg>, thisArg?: ThisParameterType<Callback<T, U, T, ThisArg>> ): U;
311311

312312
/**
313-
* Flattens an ndarray from a specified dimension while applying a callback function to each element.
313+
* Flattens an ndarray according to a callback function starting from a specified dimension.
314314
*
315315
* @param x - input ndarray
316316
* @param dim - dimension to start flattening from
@@ -351,7 +351,7 @@ declare function flattenFromBy<T extends ComplexLike = ComplexLike, U extends ty
351351
declare function flattenFromBy<T extends typedndarray<boolean> = typedndarray<boolean>, ThisArg = unknown>( x: T, dim: number, options: BaseOptions, fcn: Callback<boolean, T, boolean, ThisArg>, thisArg?: ThisParameterType<Callback<boolean, T, boolean, ThisArg>> ): T;
352352

353353
/**
354-
* Flattens an ndarray from a specified dimension while applying a callback function to each element.
354+
* Flattens an ndarray according to a callback function starting from a specified dimension.
355355
*
356356
* @param x - input ndarray
357357
* @param dim - dimension to start flattening from
@@ -391,7 +391,7 @@ declare function flattenFromBy<T extends typedndarray<boolean> = typedndarray<bo
391391
declare function flattenFromBy<T = unknown, U extends genericndarray<T> = genericndarray<T>, V = unknown, W extends genericndarray<V> = genericndarray<V>, ThisArg = unknown>( x: U, dim: number, options: BaseOptions, fcn: Callback<T, U, V, ThisArg>, thisArg?: ThisParameterType<Callback<T, U, V, ThisArg>> ): W;
392392

393393
/**
394-
* Flattens an ndarray from a specified dimension while applying a callback function to each element.
394+
* Flattens an ndarray according to a callback function starting from a specified dimension.
395395
*
396396
* @param x - input ndarray
397397
* @param dim - dimension to start flattening from

lib/node_modules/@stdlib/ndarray/flatten-from-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-
* Flatten an ndarray from a specified dimension while applying a callback function to each element.
22+
* Flatten an ndarray according to a callback function starting from a specified dimension.
2323
*
2424
* @module @stdlib/ndarray/flatten-from-by
2525
*

lib/node_modules/@stdlib/ndarray/flatten-from-by/lib/main.js

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -50,7 +50,7 @@ var COL_MAJOR = 'column-major';
5050
// MAIN //
5151

5252
/**
53-
* Flattens an ndarray from a specified dimension while applying a callback function to each element.
53+
* Flattens an ndarray according to a callback function starting from a specified dimension.
5454
*
5555
* @param {ndarray} x - input ndarray
5656
* @param {integer} dim - dimension to start flattening from

lib/node_modules/@stdlib/ndarray/flatten-from-by/package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
{
22
"name": "@stdlib/ndarray/flatten-from-by",
33
"version": "0.0.0",
4-
"description": "Flatten an ndarray from a specified dimension while applying a callback function to each element.",
4+
"description": "Flatten an ndarray according to a callback function starting from a specified dimension.",
55
"license": "Apache-2.0",
66
"author": {
77
"name": "The Stdlib Authors",

0 commit comments

Comments
 (0)