Skip to content

docs: update REPL namespace documentation #2608

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.

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
merged 1 commit into from
Jul 15, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
6 changes: 5 additions & 1 deletion lib/node_modules/@stdlib/repl/code-blocks/data/data.csv
Original file line number Diff line number Diff line change
Expand Up @@ -2571,7 +2571,10 @@ BooleanArray.prototype.byteLength,"var arr = new BooleanArray( 10 )\nvar nbytes
BooleanArray.prototype.byteOffset,"var arr = new BooleanArray( 10 )\nvar offset = arr.byteOffset\nvar buf = new ArrayBuffer( 240 );\narr = new BooleanArray( buf, 64 )\noffset = arr.byteOffset\n"
BooleanArray.prototype.BYTES_PER_ELEMENT,"var arr = new BooleanArray( 10 )\narr.BYTES_PER_ELEMENT\n"
BooleanArray.prototype.length,"var arr = new BooleanArray( 10 )\nvar len = arr.length\n"
BooleanArray.prototype.at,"var arr = new BooleanArray( [ true, false, false, true ] )\nvar v = arr.at( 1 )\nv = arr.at( -1 )\n"
BooleanArray.prototype.every,"function predicate( v ) { return v === true; };\nvar arr = new BooleanArray( [ true, true, true ] )\nvar bool = arr.every( predicate )\n"
BooleanArray.prototype.fill,"var arr = new BooleanArray( 3 )\narr.fill( true );\nvar v = arr.get( 0 )\nv = arr.get( 1 )\nv = arr.get( 2 )\n"
BooleanArray.prototype.filter,"function predicate( v ) { return ( v === true ); };\nvar arr = new BooleanArray( [ true, false, true ] )\nvar out = arr.filter( predicate )\nvar len = out.length\nvar v = out.get( 0 )\nv = out.get( 1 )\n"
BooleanArray.prototype.find,"function predicate( v ) { return v === true; };\nvar arr = new BooleanArray( [ true, false, true ] )\nvar v = arr.find( predicate )\n"
BooleanArray.prototype.findIndex,"function predicate( v ) { return v === true; };\nvar arr = new BooleanArray( [ true, false, true ] )\nvar idx = arr.findIndex( predicate )\n"
BooleanArray.prototype.findLast,"function predicate( v ) { return v === true; };\nvar arr = new BooleanArray( [ true, false, true ] )\nvar v = arr.findLast( predicate )\n"
Expand All @@ -2591,6 +2594,7 @@ BooleanArray.prototype.slice,"var arr = new BooleanArray( [ true, false, true, f
BooleanArray.prototype.some,"function predicate( v ) { return v === true; };\nvar arr = new BooleanArray( [ false, true, false ] )\nvar bool = arr.some( predicate )\n"
BooleanArray.prototype.sort,"function compare( a, b ) { return a === true ? -1 : 1; };\nvar arr = new BooleanArray( [ true, false, true ] )\narr.sort( compare );\nvar v = arr.get( 0 )\nv = arr.get( 1 )\nv = arr.get( 2 )\n"
BooleanArray.prototype.subarray,"var arr = new BooleanArray( [ true, false, true, false, true ] )\nvar out = arr.subarray( 1, 3 )\nvar len = out.length\nvar v = out.get( 0 )\nv = out.get( 1 )\n"
BooleanArray.prototype.toLocaleString,"var arr = new BooleanArray( [ true, false, true ] )\nvar str = arr.toLocaleString()\n"
BooleanArray.prototype.toReversed,"var arr = new BooleanArray( [ true, false, false ] )\nvar out = arr.toReversed()\nvar v = out.get( 0 )\nv = out.get( 1 )\nv = out.get( 2 )\n"
BooleanArray.prototype.toSorted,"function compare( a, b ) { return a === true ? -1 : 1; };\nvar arr = new BooleanArray( [ true, false, true ] )\nvar out = arr.toSorted( compare );\nvar v = out.get( 0 )\nv = out.get( 1 )\nv = out.get( 2 )\n"
BooleanArray.prototype.toString,"var arr = new BooleanArray( [ true, false, true ] )\nvar str = arr.toString()\n"
Expand Down Expand Up @@ -4089,7 +4093,7 @@ ndarray2array,"var arr = array( [ [ 1, 2 ], [ 3, 4 ] ] );\nvar out = ndarray2arr
ndarrayCastingModes,"var out = ndarrayCastingModes()\n"
ndarrayDataBuffer,"var opts = { 'dtype': 'float64' };\nvar out = ndarrayDataBuffer( ndzeros( [ 3, 3, 3 ], opts ) )\n"
ndarrayDataType,"var opts = { 'dtype': 'float64' };\nvar dt = ndarrayDataType( ndzeros( [ 3, 3, 3 ], opts ) )\n"
ndarrayDataTypes,"var out = ndarrayDataTypes()\nout = ndarrayDataTypes( 'floating_point' )\n"
ndarrayDataTypes,"var out = ndarrayDataTypes()\nout = ndarrayDataTypes( 'floating_point' )\nout = ndarrayDataTypes( 'floating_point_and_generic' )\n"
ndarrayDispatch,"var t = [ 'float64', 'float64', 'float32', 'float32' ];\nvar d = [ base.abs, base.absf ];\nvar f = ndarrayDispatch( base.ndarrayUnary, t, d, 2, 1, 1 );\nvar xbuf = new Float64Array( [ -1.0, -2.0, -3.0, -4.0 ] );\nvar x = ndarray( 'float64', xbuf, [ 4 ], [ 1 ], 0, 'row-major' );\nvar ybuf = new Float64Array( [ 0.0, 0.0, 0.0, 0.0 ] );\nvar y = ndarray( 'float64', ybuf, [ 4 ], [ 1 ], 0, 'row-major' );\nf( x, y );\nybuf\n"
ndarrayFlag,"var out = ndarrayFlag( ndzeros( [ 3, 3, 3 ] ), 'READONLY' )\n"
ndarrayFlags,"var out = ndarrayFlags( ndzeros( [ 3, 3, 3 ] ) )\n"
Expand Down
2 changes: 1 addition & 1 deletion lib/node_modules/@stdlib/repl/code-blocks/data/data.json

Large diffs are not rendered by default.

8 changes: 6 additions & 2 deletions lib/node_modules/@stdlib/repl/help/data/data.csv

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion lib/node_modules/@stdlib/repl/help/data/data.json

Large diffs are not rendered by default.

4 changes: 4 additions & 0 deletions lib/node_modules/@stdlib/repl/info/data/data.csv
Original file line number Diff line number Diff line change
Expand Up @@ -2571,7 +2571,10 @@ BooleanArray.prototype.byteLength,"\nBooleanArray.prototype.byteLength\n Size
BooleanArray.prototype.byteOffset,"\nBooleanArray.prototype.byteOffset\n Offset (in bytes) of the array from the start of its underlying\n ArrayBuffer.\n"
BooleanArray.prototype.BYTES_PER_ELEMENT,"\nBooleanArray.prototype.BYTES_PER_ELEMENT\n Size (in bytes) of each array element.\n"
BooleanArray.prototype.length,"\nBooleanArray.prototype.length\n The number of array elements.\n"
BooleanArray.prototype.at,"\nBooleanArray.prototype.at( i:integer )\n Returns an array element located at integer position (index) `i`, with\n support for noth nonnegative and negative integer positions.\n"
BooleanArray.prototype.every,"\nBooleanArray.prototype.every( predicate:Function[, thisArg:Any] )\n Returns a boolean indicating whether all elements in the array pass a test.\n"
BooleanArray.prototype.fill,"\nBooleanArray.prototype.fill( value:boolean[, start:integer[, end:integer]] )\n Returns a modified typed array filled with a fill value.\n"
BooleanArray.prototype.filter,"\nBooleanArray.prototype.filter( predicate:Function[, thisArg:Any] )\n Returns a new array containing the elements of an array which pass a test\n implemented by a predicate function.\n"
BooleanArray.prototype.find,"\nBooleanArray.prototype.find( predicate:Function[, thisArg:Any] )\n Returns the first element in an array for which a predicate function returns\n a truthy value.\n"
BooleanArray.prototype.findIndex,"\nBooleanArray.prototype.findIndex( predicate:Function[, thisArg:Any] )\n Returns the index of the first element in an array for which a predicate\n function returns a truthy value.\n"
BooleanArray.prototype.findLast,"\nBooleanArray.prototype.findLast( predicate:Function[, thisArg:Any] )\n Returns the last element in an array for which a predicate function returns\n a truthy value.\n"
Expand All @@ -2591,6 +2594,7 @@ BooleanArray.prototype.slice,"\nBooleanArray.prototype.slice( [start:integer[, e
BooleanArray.prototype.some,"\nBooleanArray.prototype.some( predicate:Function[, thisArg:Any] )\n Returns a boolean indicating whether at least one element passes a test.\n"
BooleanArray.prototype.sort,"\nBooleanArray.prototype.sort( [compareFunction:Function] )\n Sorts an array in-place.\n"
BooleanArray.prototype.subarray,"\nBooleanArray.prototype.subarray( [begin:integer[, end:integer]] )\n Creates a new typed array view over the same underlying `ArrayBuffer` and\n with the same underlying data type as the host array.\n"
BooleanArray.prototype.toLocaleString,"\nBooleanArray.prototype.toLocaleString( [locales[, options]] )\n Serializes an array as a locale-specific string.\n"
BooleanArray.prototype.toReversed,"\nBooleanArray.prototype.toReversed()\n Returns a new typed array containing the elements in reversed order.\n"
BooleanArray.prototype.toSorted,"\nBooleanArray.prototype.toSorted( [compareFunction:Function] )\n Returns a new typed array containing the elements in sorted order.\n"
BooleanArray.prototype.toString,"\nBooleanArray.prototype.toString()\n Serializes an array as a string.\n"
Expand Down
2 changes: 1 addition & 1 deletion lib/node_modules/@stdlib/repl/info/data/data.json

Large diffs are not rendered by default.

4 changes: 4 additions & 0 deletions lib/node_modules/@stdlib/repl/signature/data/data.csv
Original file line number Diff line number Diff line change
Expand Up @@ -2577,7 +2577,10 @@ BooleanArray.prototype.byteLength,"BooleanArray.prototype.byteLength"
BooleanArray.prototype.byteOffset,"BooleanArray.prototype.byteOffset"
BooleanArray.prototype.BYTES_PER_ELEMENT,"BooleanArray.prototype.BYTES_PER_ELEMENT"
BooleanArray.prototype.length,"BooleanArray.prototype.length"
BooleanArray.prototype.at,"BooleanArray.prototype.at( i )"
BooleanArray.prototype.every,"BooleanArray.prototype.every( predicate[, thisArg] )"
BooleanArray.prototype.fill,"BooleanArray.prototype.fill( value[, start[, end]] )"
BooleanArray.prototype.filter,"BooleanArray.prototype.filter( predicate[, thisArg] )"
BooleanArray.prototype.find,"BooleanArray.prototype.find( predicate[, thisArg] )"
BooleanArray.prototype.findIndex,"BooleanArray.prototype.findIndex( predicate[, thisArg] )"
BooleanArray.prototype.findLast,"BooleanArray.prototype.findLast( predicate[, thisArg] )"
Expand All @@ -2597,6 +2600,7 @@ BooleanArray.prototype.slice,"BooleanArray.prototype.slice( [start[, end]] )"
BooleanArray.prototype.some,"BooleanArray.prototype.some( predicate[, thisArg] )"
BooleanArray.prototype.sort,"BooleanArray.prototype.sort( [compareFunction] )"
BooleanArray.prototype.subarray,"BooleanArray.prototype.subarray( [begin[, end]] )"
BooleanArray.prototype.toLocaleString,"BooleanArray.prototype.toLocaleString( [locales[, options]] )"
BooleanArray.prototype.toReversed,"BooleanArray.prototype.toReversed()"
BooleanArray.prototype.toSorted,"BooleanArray.prototype.toSorted( [compareFunction] )"
BooleanArray.prototype.toString,"BooleanArray.prototype.toString()"
Expand Down
2 changes: 1 addition & 1 deletion lib/node_modules/@stdlib/repl/signature/data/data.json

Large diffs are not rendered by default.

4 changes: 4 additions & 0 deletions lib/node_modules/@stdlib/repl/typed-signature/data/data.csv
Original file line number Diff line number Diff line change
Expand Up @@ -2577,7 +2577,10 @@ BooleanArray.prototype.byteLength,"BooleanArray.prototype.byteLength"
BooleanArray.prototype.byteOffset,"BooleanArray.prototype.byteOffset"
BooleanArray.prototype.BYTES_PER_ELEMENT,"BooleanArray.prototype.BYTES_PER_ELEMENT"
BooleanArray.prototype.length,"BooleanArray.prototype.length"
BooleanArray.prototype.at,"BooleanArray.prototype.at( i:integer )"
BooleanArray.prototype.every,"BooleanArray.prototype.every( predicate:Function[, thisArg:Any] )"
BooleanArray.prototype.fill,"BooleanArray.prototype.fill( value:boolean[, start:integer[, end:integer]] )"
BooleanArray.prototype.filter,"BooleanArray.prototype.filter( predicate:Function[, thisArg:Any] )"
BooleanArray.prototype.find,"BooleanArray.prototype.find( predicate:Function[, thisArg:Any] )"
BooleanArray.prototype.findIndex,"BooleanArray.prototype.findIndex( predicate:Function[, thisArg:Any] )"
BooleanArray.prototype.findLast,"BooleanArray.prototype.findLast( predicate:Function[, thisArg:Any] )"
Expand All @@ -2597,6 +2600,7 @@ BooleanArray.prototype.slice,"BooleanArray.prototype.slice( [start:integer[, end
BooleanArray.prototype.some,"BooleanArray.prototype.some( predicate:Function[, thisArg:Any] )"
BooleanArray.prototype.sort,"BooleanArray.prototype.sort( [compareFunction:Function] )"
BooleanArray.prototype.subarray,"BooleanArray.prototype.subarray( [begin:integer[, end:integer]] )"
BooleanArray.prototype.toLocaleString,"BooleanArray.prototype.toLocaleString( [locales[, options]] )"
BooleanArray.prototype.toReversed,"BooleanArray.prototype.toReversed()"
BooleanArray.prototype.toSorted,"BooleanArray.prototype.toSorted( [compareFunction:Function] )"
BooleanArray.prototype.toString,"BooleanArray.prototype.toString()"
Expand Down

Large diffs are not rendered by default.

Loading