Skip to content

docs: fix description and add missing spaces #14202

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
kgryte merged 2 commits into from
Aug 12, 2026
Merged

docs: fix description and add missing spaces #14202

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
60a037b
docs: remove duplicate period in comment in `constants/float32/eps`
claude Aug 12, 2026
cf5511b
style: add missing spaces in `ndarray` and `string` doc examples
claude Aug 12, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion lib/node_modules/@stdlib/constants/float32/eps/include/stdlib/constants/float32/eps.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@
#define STDLIB_CONSTANTS_FLOAT32_EPS_H

/**
* Macro for the difference between one and the smallest value greater than one that can be represented as a single-precision floating-point number..
* Macro for the difference between one and the smallest value greater than one that can be represented as a single-precision floating-point number.
*/
#define STDLIB_CONSTANT_FLOAT32_EPS 1.1920928955078125e-7f

Expand Down
52 changes: 26 additions & 26 deletions lib/node_modules/@stdlib/ndarray/broadcast-scalar-like/docs/types/index.d.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -223,7 +223,7 @@
* // returns <ndarray>
*
* var out = broadcastScalarLike( x, 1.0, {
* 'dtype': 'float64'
* 'dtype': 'float64'
* });
* // returns <ndarray>
*/
Expand All @@ -241,7 +241,7 @@
* var empty = require( '@stdlib/ndarray/empty' );
*
* var x = empty( [ 2, 2 ], {
* 'dtype': 'float32'
* 'dtype': 'float32'
* });
* // returns <ndarray>
*
Expand All @@ -265,7 +265,7 @@
* // returns <ndarray>
*
* var out = broadcastScalarLike( x, 1.0, {
* 'dtype': 'float32'
* 'dtype': 'float32'
* });
* // returns <ndarray>
*/
Expand All @@ -283,7 +283,7 @@
* var empty = require( '@stdlib/ndarray/empty' );
*
* var x = empty( [ 2, 2 ], {
* 'dtype': 'complex128'
* 'dtype': 'complex128'
* });
* // returns <ndarray>
*
Expand All @@ -307,7 +307,7 @@
* // returns <ndarray>
*
* var out = broadcastScalarLike( x, 1.0, {
* 'dtype': 'complex128'
* 'dtype': 'complex128'
* });
* // returns <ndarray>
*/
Expand All @@ -325,7 +325,7 @@
* var empty = require( '@stdlib/ndarray/empty' );
*
* var x = empty( [ 2, 2 ], {
* 'dtype': 'complex64'
* 'dtype': 'complex64'
* });
* // returns <ndarray>
*
Expand All @@ -349,7 +349,7 @@
* // returns <ndarray>
*
* var out = broadcastScalarLike( x, 1.0, {
* 'dtype': 'complex64'
* 'dtype': 'complex64'
* });
* // returns <ndarray>
*/
Expand All @@ -367,7 +367,7 @@
* var empty = require( '@stdlib/ndarray/empty' );
*
* var x = empty( [ 2, 2 ], {
* 'dtype': 'bool'
* 'dtype': 'bool'
* });
* // returns <ndarray>
*
Expand All @@ -391,7 +391,7 @@
* // returns <ndarray>
*
* var out = broadcastScalarLike( x, true, {
* 'dtype': 'bool'
* 'dtype': 'bool'
* });
* // returns <ndarray>
*/
Expand All @@ -409,7 +409,7 @@
* var empty = require( '@stdlib/ndarray/empty' );
*
* var x = empty( [ 2, 2 ], {
* 'dtype': 'int32'
* 'dtype': 'int32'
* });
* // returns <ndarray>
*
Expand All @@ -433,7 +433,7 @@
* // returns <ndarray>
*
* var out = broadcastScalarLike( x, 1.0, {
* 'dtype': 'int32'
* 'dtype': 'int32'
* });
* // returns <ndarray>
*/
Expand All @@ -451,7 +451,7 @@
* var empty = require( '@stdlib/ndarray/empty' );
*
* var x = empty( [ 2, 2 ], {
* 'dtype': 'int16'
* 'dtype': 'int16'
* });
* // returns <ndarray>
*
Expand All @@ -475,7 +475,7 @@
* // returns <ndarray>
*
* var out = broadcastScalarLike( x, 1.0, {
* 'dtype': 'int16'
* 'dtype': 'int16'
* });
* // returns <ndarray>
*/
Expand All @@ -493,7 +493,7 @@
* var empty = require( '@stdlib/ndarray/empty' );
*
* var x = empty( [ 2, 2 ], {
* 'dtype': 'int8'
* 'dtype': 'int8'
* });
* // returns <ndarray>
*
Expand All @@ -517,7 +517,7 @@
* // returns <ndarray>
*
* var out = broadcastScalarLike( x, 1.0, {
* 'dtype': 'int8'
* 'dtype': 'int8'
* });
* // returns <ndarray>
*/
Expand All @@ -535,7 +535,7 @@
* var empty = require( '@stdlib/ndarray/empty' );
*
* var x = empty( [ 2, 2 ], {
* 'dtype': 'uint32'
* 'dtype': 'uint32'
* });
* // returns <ndarray>
*
Expand All @@ -559,7 +559,7 @@
* // returns <ndarray>
*
* var out = broadcastScalarLike( x, 1.0, {
* 'dtype': 'uint32'
* 'dtype': 'uint32'
* });
* // returns <ndarray>
*/
Expand All @@ -577,7 +577,7 @@
* var empty = require( '@stdlib/ndarray/empty' );
*
* var x = empty( [ 2, 2 ], {
* 'dtype': 'uint16'
* 'dtype': 'uint16'
* });
* // returns <ndarray>
*
Expand All @@ -601,7 +601,7 @@
* // returns <ndarray>
*
* var out = broadcastScalarLike( x, 1.0, {
* 'dtype': 'uint16'
* 'dtype': 'uint16'
* });
* // returns <ndarray>
*/
Expand All @@ -619,7 +619,7 @@
* var empty = require( '@stdlib/ndarray/empty' );
*
* var x = empty( [ 2, 2 ], {
* 'dtype': 'uint8'
* 'dtype': 'uint8'
* });
* // returns <ndarray>
*
Expand All @@ -643,7 +643,7 @@
* // returns <ndarray>
*
* var out = broadcastScalarLike( x, 1.0, {
* 'dtype': 'uint8'
* 'dtype': 'uint8'
* });
* // returns <ndarray>
*/
Expand All @@ -661,7 +661,7 @@
* var empty = require( '@stdlib/ndarray/empty' );
*
* var x = empty( [ 2, 2 ], {
* 'dtype': 'uint8c'
* 'dtype': 'uint8c'
* });
* // returns <ndarray>
*
Expand All @@ -685,7 +685,7 @@
* // returns <ndarray>
*
* var out = broadcastScalarLike( x, 1.0, {
* 'dtype': 'uint8c'
* 'dtype': 'uint8c'
* });
* // returns <ndarray>
*/
Expand All @@ -703,14 +703,14 @@
* var empty = require( '@stdlib/ndarray/empty' );
*
* var x = empty( [ 2, 2 ], {
* 'dtype': 'generic'
* 'dtype': 'generic'
* });
* // returns <ndarray>
*
* var out = broadcastScalarLike( x, 1.0 );
* // returns <ndarray>
*/
declare function broadcastScalarLike<T = unknown>( x: genericndarray<any>, value: T, options?: BaseOptions ): genericndarray<T>;

Check warning on line 713 in lib/node_modules/@stdlib/ndarray/broadcast-scalar-like/docs/types/index.d.ts

View workflow job for this annotation

GitHub Actions / Lint Changed Files 

Unexpected any. Specify a different type

/**
* Broadcasts a scalar value to an ndarray having the same shape and data type as a provided input ndarray.
Expand All @@ -727,7 +727,7 @@
* // returns <ndarray>
*
* var out = broadcastScalarLike( x, 1.0, {
* 'dtype': 'generic'
* 'dtype': 'generic'
* });
* // returns <ndarray>
*/
Expand All @@ -745,7 +745,7 @@
* var empty = require( '@stdlib/ndarray/empty' );
*
* var x = empty( [ 2, 2 ], {
* 'dtype': 'generic'
* 'dtype': 'generic'
* });
* // returns <ndarray>
*
Expand Down
2 changes: 1 addition & 1 deletion lib/node_modules/@stdlib/ndarray/docs/types/index.d.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -554,7 +554,7 @@ interface Namespace {
* var empty = require( '@stdlib/ndarray/empty' );
*
* var x = empty( [ 2, 2 ], {
* 'dtype': 'generic'
* 'dtype': 'generic'
* });
* // returns <ndarray>
*
Expand Down
2 changes: 1 addition & 1 deletion lib/node_modules/@stdlib/ndarray/find-last/docs/types/index.d.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -173,7 +173,7 @@ interface FindLast {
* var x = new ndarray( 'float64', xbuf, sh, sx, ox, 'row-major' );
*
* var opts = {
* 'dims': [ 0 ]
* 'dims': [ 0 ]
* };
*
* // Perform the operation:
Expand Down
2 changes: 1 addition & 1 deletion lib/node_modules/@stdlib/ndarray/find/docs/types/index.d.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -176,7 +176,7 @@ interface Find {
* var x = new ndarray( 'float64', xbuf, sh, sx, ox, 'row-major' );
*
* var opts = {
* 'dims': [ 0 ]
* 'dims': [ 0 ]
* };
*
* // Perform the operation:
Expand Down
Loading