Skip to content

Commit 199b4c8

Browse files
committed
docs: apply suggestions from code review
1 parent 7cead76 commit 199b4c8

File tree

6 files changed

+12
-12
lines changed

6 files changed

+12
-12
lines changed

lib/node_modules/@stdlib/ndarray/base/pop/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
# pop
2222

23-
> Return an array containing a truncated view of an input ndarray and the last element along a specified dimension.
23+
> Return an array containing a truncated view of an input ndarray and a complementary view of the last element(s) along a specified dimension.
2424
2525
<!-- Section to include introductory text. Make sure to keep an empty line after the intro `section` element and another before the `/section` close. -->
2626

@@ -42,7 +42,7 @@ var pop = require( '@stdlib/ndarray/base/pop' );
4242

4343
#### pop( x, dim, strict, writable )
4444

45-
Returns an array containing a truncated view of an input ndarray and the last element along a specified dimension.
45+
Returns an array containing a truncated view of an input ndarray and a complementary view of the last element(s) along a specified dimension.
4646

4747
```javascript
4848
var ndarray = require( '@stdlib/ndarray/ctor' );

lib/node_modules/@stdlib/ndarray/base/pop/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, strict, writable )
3-
Returns an array containing a truncated view of an input ndarray and the
4-
last element along a specified dimension.
3+
Returns an array containing a truncated view of an input ndarray and a
4+
complementary view of the last element(s) along a specified dimension.
55

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

lib/node_modules/@stdlib/ndarray/base/pop/docs/types/index.d.ts

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,7 @@ import { ArrayLike } from '@stdlib/types/array';
2626

2727

2828
/**
29-
* Returns an array containing a truncated view of an input ndarray and the last element along a specified dimension.
29+
* Returns an array containing a truncated view of an input ndarray and a complementary view of the last element(s) along a specified dimension.
3030
*
3131
* @param x - input array
3232
* @param dim - dimension along which to perform the operation
@@ -62,7 +62,7 @@ import { ArrayLike } from '@stdlib/types/array';
6262
declare function pop<T extends typedndarray<number> = typedndarray<number>>( x: T, dim: number, strict: boolean, writable: boolean ): ArrayLike<T>;
6363

6464
/**
65-
* Returns an array containing a truncated view of an input ndarray and the last element along a specified dimension.
65+
* Returns an array containing a truncated view of an input ndarray and a complementary view of the last element(s) along a specified dimension.
6666
*
6767
* @param x - input array
6868
* @param dim - dimension along which to perform the operation
@@ -80,7 +80,7 @@ declare function pop<T extends typedndarray<number> = typedndarray<number>>( x:
8080
* var strides = [ 2, 1 ];
8181
* var offset = 0;
8282
*
83-
* var x = ndarray( 'float64', buffer, shape, strides, offset, 'row-major' );
83+
* var x = ndarray( 'complex64', buffer, shape, strides, offset, 'row-major' );
8484
* // returns <ndarray>
8585
*
8686
* var arr = ndarray2array( x );
@@ -98,7 +98,7 @@ declare function pop<T extends typedndarray<number> = typedndarray<number>>( x:
9898
declare function pop<T extends ComplexLike = ComplexLike, U extends typedndarray<T> = typedndarray<T>>( x: U, dim: number, strict: boolean, writable: boolean ): ArrayLike<U>;
9999

100100
/**
101-
* Returns an array containing a truncated view of an input ndarray and the last element along a specified dimension.
101+
* Returns an array containing a truncated view of an input ndarray and a complementary view of the last element(s) along a specified dimension.
102102
*
103103
* @param x - input array
104104
* @param dim - dimension along which to perform the operation
@@ -134,7 +134,7 @@ declare function pop<T extends ComplexLike = ComplexLike, U extends typedndarray
134134
declare function pop<T extends typedndarray<boolean> = typedndarray<boolean>>( x: T, dim: number, strict: boolean, writable: boolean ): ArrayLike<T>;
135135

136136
/**
137-
* Returns an array containing a truncated view of an input ndarray and the last element along a specified dimension.
137+
* Returns an array containing a truncated view of an input ndarray and a complementary view of the last element(s) along a specified dimension.
138138
*
139139
* @param x - input array
140140
* @param dim - dimension along which to perform the operation

lib/node_modules/@stdlib/ndarray/base/pop/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-
* Return an array containing a truncated view of an input ndarray and the last element along a specified dimension.
22+
* Return an array containing a truncated view of an input ndarray and a complementary view of the last element(s) along a specified dimension.
2323
*
2424
* @module @stdlib/ndarray/base/pop
2525
*

lib/node_modules/@stdlib/ndarray/base/pop/lib/main.js

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,7 @@ var sliceTo = require( '@stdlib/ndarray/base/slice-to' );
3030
// MAIN //
3131

3232
/**
33-
* Returns an array containing a truncated view of an input ndarray and the last element along a specified dimension.
33+
* Returns an array containing a truncated view of an input ndarray and a complementary view of the last element(s) along a specified dimension.
3434
*
3535
* @param {ndarray} x - input array
3636
* @param {integer} dim - dimension along which to perform the operation

lib/node_modules/@stdlib/ndarray/base/pop/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/base/pop",
33
"version": "0.0.0",
4-
"description": "Return an array containing a truncated view of an input ndarray and the last element along a specified dimension.",
4+
"description": "Return an array containing a truncated view of an input ndarray and a complementary view of the last element(s) along a specified dimension.",
55
"license": "Apache-2.0",
66
"author": {
77
"name": "The Stdlib Authors",

0 commit comments

Comments
 (0)