Skip to content

Commit

Permalink
docs: update REPL namespace documentation
Browse files Browse the repository at this point in the history
PR-URL: #2570
Co-authored-by: Athan Reines <kgryte@gmail.com>
Reviewed-by: Athan Reines <kgryte@gmail.com> 
Signed-off-by: stdlib-bot <82920195+stdlib-bot@users.noreply.github.com>
  • Loading branch information
stdlib-bot and kgryte authored Jul 12, 2024
1 parent 5a66b4b commit 8751c3d
Show file tree
Hide file tree
Showing 10 changed files with 17 additions and 7 deletions.
2 changes: 2 additions & 0 deletions lib/node_modules/@stdlib/repl/code-blocks/data/data.csv
Original file line number Diff line number Diff line change
Expand Up @@ -2579,6 +2579,7 @@ BooleanArray.prototype.findLastIndex,"function predicate( v ) { return v === tru
BooleanArray.prototype.get,"var arr = new BooleanArray( 10 )\narr.set( true, 0 );\nvar v = arr.get( 0 )\n"
BooleanArray.prototype.includes,"var arr = new BooleanArray( [ true, false, true, true, true ] )\nvar bool = arr.includes( true )\nbool = arr.includes( false, 3 )\n"
BooleanArray.prototype.indexOf,"var arr = new BooleanArray( [ true, false, true, true, true ] )\nvar idx = arr.indexOf( true )\nidx = arr.indexOf( false, 3 )\n"
BooleanArray.prototype.join,"var arr = new BooleanArray( [ true, false, true ] )\nvar str = arr.join()\nstr = arr.join( '|' )\n"
BooleanArray.prototype.lastIndexOf,"var arr = new BooleanArray( [ true, true, true, false, true ] )\nvar idx = arr.lastIndexOf( false )\nidx = arr.lastIndexOf( false, 2 )\n"
BooleanArray.prototype.map,"function invert( v ) { return !v; };\nvar arr = new BooleanArray( [ true, false, true ] )\nvar out = arr.map( invert )\nvar v = out.get( 0 )\nv = out.get( 1 )\nv = out.get( 2 )\n"
BooleanArray.prototype.reduce,"function reducer( acc, v ) { return ( acc && v ); };\nvar arr = new BooleanArray( [ true, false, true ] )\nvar out = arr.reduce( reducer )\n"
Expand All @@ -2591,6 +2592,7 @@ BooleanArray.prototype.sort,"function compare( a, b ) { return a === true ? -1 :
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.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"
broadcastArray,"var x = array( [ [ 1, 2 ], [ 3, 4 ] ] )\nvar sh = x.shape\nvar y = broadcastArray( x, [ 3, 2, 2 ] )\nsh = y.shape\nvar v = y.get( 0, 0, 0 )\nv = y.get( 0, 0, 1 )\nv = y.get( 0, 1, 0 )\nv = y.get( 0, 1, 1 )\nv = y.get( 1, 0, 0 )\nv = y.get( 1, 1, 0 )\nv = y.get( 2, 0, 0 )\nv = y.get( 2, 1, 1 )\n"
broadcastArrays,"var x = array( [ [ 1, 2 ], [ 3, 4 ] ] )\nvar sh = x.shape\nvar y = ndzeros( [ 3, 2, 2 ] )\nvar out = broadcastArrays( [ x, y ] )\nvar bx = out[ 0 ]\nsh = bx.shape\nvar v = bx.get( 0, 0, 0 )\nv = bx.get( 0, 0, 1 )\nv = bx.get( 0, 1, 0 )\nv = bx.get( 0, 1, 1 )\nv = bx.get( 1, 0, 0 )\nv = bx.get( 1, 1, 0 )\nv = bx.get( 2, 0, 0 )\nv = bx.get( 2, 1, 1 )\n"
Buffer,"var b = new Buffer( 4 )\nvar b1 = new Buffer( [ 1, 2, 3, 4 ] );\nvar b2 = new Buffer( b1 )\nvar b = new Buffer( [ 1, 2, 3, 4 ] )\nvar b = new Buffer( 'beep boop' )\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.

6 changes: 4 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.

2 changes: 2 additions & 0 deletions lib/node_modules/@stdlib/repl/info/data/data.csv
Original file line number Diff line number Diff line change
Expand Up @@ -2579,6 +2579,7 @@ BooleanArray.prototype.findLastIndex,"\nBooleanArray.prototype.findLastIndex( pr
BooleanArray.prototype.get,"\nBooleanArray.prototype.get( i:integer )\n Returns an array element located at integer position (index) `i`.\n"
BooleanArray.prototype.includes,"\nBooleanArray.prototype.includes( searchElement:boolean[, fromIndex:integer] )\n Returns a boolean indicating whether an array includes a provided value.\n"
BooleanArray.prototype.indexOf,"\nBooleanArray.prototype.indexOf( searchElement:boolean[, fromIndex:integer] )\n Returns the first index at which a given element can be found.\n"
BooleanArray.prototype.join,"\nBooleanArray.prototype.join( [separator:string] )\n Returns a new string by concatenating all array elements separated by a\n separator string.\n"
BooleanArray.prototype.lastIndexOf,"\nBooleanArray.prototype.lastIndexOf( searchElement:boolean[, fromIndex:integer] )\n Returns the last index at which a given element can be found.\n"
BooleanArray.prototype.map,"\nBooleanArray.prototype.map( clbk:Function[, thisArg:Any] )\n Returns a new array with each element being the result of a provided\n callback function.\n"
BooleanArray.prototype.reduce,"\nBooleanArray.prototype.reduce( reducerFn:Function[, initialValue:any] )\n Applies a provided function to each element of the array, in order, passing\n in the return value from the calculation on the preceding element and\n returning the accumulated result upon completion.\n"
Expand All @@ -2591,6 +2592,7 @@ BooleanArray.prototype.sort,"\nBooleanArray.prototype.sort( [compareFunction:Fun
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.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"
broadcastArray,"\nbroadcastArray( x:ndarray, shape:ArrayLikeObject )\n Broadcasts an ndarray to a specified shape.\n"
broadcastArrays,"\nbroadcastArrays( ...arrays:ndarray|ArrayLikeObject<ndarray> )\n Broadcasts ndarrays to a common shape.\n"
Buffer,"\nBuffer\n\nBuffer( size:integer )\n Allocates a buffer having a specified number of bytes.\n\nBuffer( buffer:Buffer )\n Copies buffer data to a new Buffer instance.\n\nBuffer( array:Array )\n Allocates a buffer using an array of octets.\n\nBuffer( str:string[, encoding:string] )\n Allocates a buffer containing a provided 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.

2 changes: 2 additions & 0 deletions lib/node_modules/@stdlib/repl/signature/data/data.csv
Original file line number Diff line number Diff line change
Expand Up @@ -2585,6 +2585,7 @@ BooleanArray.prototype.findLastIndex,"BooleanArray.prototype.findLastIndex( pred
BooleanArray.prototype.get,"BooleanArray.prototype.get( i )"
BooleanArray.prototype.includes,"BooleanArray.prototype.includes( searchElement[, fromIndex] )"
BooleanArray.prototype.indexOf,"BooleanArray.prototype.indexOf( searchElement[, fromIndex] )"
BooleanArray.prototype.join,"BooleanArray.prototype.join( [separator] )"
BooleanArray.prototype.lastIndexOf,"BooleanArray.prototype.lastIndexOf( searchElement[, fromIndex] )"
BooleanArray.prototype.map,"BooleanArray.prototype.map( clbk[, thisArg] )"
BooleanArray.prototype.reduce,"BooleanArray.prototype.reduce( reducerFn[, initialValue] )"
Expand All @@ -2597,6 +2598,7 @@ BooleanArray.prototype.sort,"BooleanArray.prototype.sort( [compareFunction] )"
BooleanArray.prototype.subarray,"BooleanArray.prototype.subarray( [begin[, end]] )"
BooleanArray.prototype.toReversed,"BooleanArray.prototype.toReversed()"
BooleanArray.prototype.toSorted,"BooleanArray.prototype.toSorted( [compareFunction] )"
BooleanArray.prototype.toString,"BooleanArray.prototype.toString()"
broadcastArray,"broadcastArray( x, shape )"
broadcastArrays,"broadcastArrays( ...arrays )"
Buffer,"Buffer"
Expand Down
2 changes: 1 addition & 1 deletion lib/node_modules/@stdlib/repl/signature/data/data.json

Large diffs are not rendered by default.

2 changes: 2 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 @@ -2585,6 +2585,7 @@ BooleanArray.prototype.findLastIndex,"BooleanArray.prototype.findLastIndex( pred
BooleanArray.prototype.get,"BooleanArray.prototype.get( i:integer )"
BooleanArray.prototype.includes,"BooleanArray.prototype.includes( searchElement:boolean[, fromIndex:integer] )"
BooleanArray.prototype.indexOf,"BooleanArray.prototype.indexOf( searchElement:boolean[, fromIndex:integer] )"
BooleanArray.prototype.join,"BooleanArray.prototype.join( [separator:string] )"
BooleanArray.prototype.lastIndexOf,"BooleanArray.prototype.lastIndexOf( searchElement:boolean[, fromIndex:integer] )"
BooleanArray.prototype.map,"BooleanArray.prototype.map( clbk:Function[, thisArg:Any] )"
BooleanArray.prototype.reduce,"BooleanArray.prototype.reduce( reducerFn:Function[, initialValue:any] )"
Expand All @@ -2597,6 +2598,7 @@ BooleanArray.prototype.sort,"BooleanArray.prototype.sort( [compareFunction:Funct
BooleanArray.prototype.subarray,"BooleanArray.prototype.subarray( [begin:integer[, end:integer]] )"
BooleanArray.prototype.toReversed,"BooleanArray.prototype.toReversed()"
BooleanArray.prototype.toSorted,"BooleanArray.prototype.toSorted( [compareFunction:Function] )"
BooleanArray.prototype.toString,"BooleanArray.prototype.toString()"
broadcastArray,"broadcastArray( x:ndarray, shape:ArrayLikeObject )"
broadcastArrays,"broadcastArrays( ...arrays:ndarray|ArrayLikeObject<ndarray> )"
Buffer,"Buffer"
Expand Down

Large diffs are not rendered by default.

1 comment on commit 8751c3d

@stdlib-bot
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Coverage Report

Package Statements Branches Functions Lines
repl/code-blocks $\color{green}95/95$
$\color{green}+100.00\%$
$\color{green}7/7$
$\color{green}+100.00\%$
$\color{green}1/1$
$\color{green}+100.00\%$
$\color{green}95/95$
$\color{green}+100.00\%$
repl/help $\color{green}95/95$
$\color{green}+100.00\%$
$\color{green}7/7$
$\color{green}+100.00\%$
$\color{green}1/1$
$\color{green}+100.00\%$
$\color{green}95/95$
$\color{green}+100.00\%$
repl/info $\color{green}95/95$
$\color{green}+100.00\%$
$\color{green}7/7$
$\color{green}+100.00\%$
$\color{green}1/1$
$\color{green}+100.00\%$
$\color{green}95/95$
$\color{green}+100.00\%$
repl/signature $\color{green}99/99$
$\color{green}+100.00\%$
$\color{green}10/10$
$\color{green}+100.00\%$
$\color{green}1/1$
$\color{green}+100.00\%$
$\color{green}99/99$
$\color{green}+100.00\%$
repl/typed-signature $\color{green}99/99$
$\color{green}+100.00\%$
$\color{green}10/10$
$\color{green}+100.00\%$
$\color{green}1/1$
$\color{green}+100.00\%$
$\color{green}99/99$
$\color{green}+100.00\%$

The above coverage report was generated for the changes in this push.

Please sign in to comment.