Skip to content

Commit

Permalink
docs: update REPL namespace documentation
Browse files Browse the repository at this point in the history
PR-URL: #2629
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 19, 2024
1 parent bd258a3 commit c89a171
Show file tree
Hide file tree
Showing 16 changed files with 30 additions and 15 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -211,8 +211,8 @@ base.cidentityf,"@stdlib/math-base-special-cidentityf"
base.cinv,"@stdlib/math-base-special-cinv"
base.clamp,"@stdlib/math-base-special-clamp"
base.clampf,"@stdlib/math-base-special-clampf"
base.cmul,"@stdlib/math-base-ops-cmul"
base.cmulf,"@stdlib/math-base-ops-cmulf"
base.cmul,"@stdlib/complex-float64-base-mul"
base.cmulf,"@stdlib/complex-float32-base-mul"
base.cneg,"@stdlib/math-base-ops-cneg"
base.cnegf,"@stdlib/math-base-ops-cnegf"
base.codePointAt,"@stdlib/string-base-code-point-at"
Expand Down

Large diffs are not rendered by default.

Original file line number Diff line number Diff line change
Expand Up @@ -211,8 +211,8 @@
"@stdlib/math/base/special/cinv","@stdlib/math-base-special-cinv"
"@stdlib/math/base/special/clamp","@stdlib/math-base-special-clamp"
"@stdlib/math/base/special/clampf","@stdlib/math-base-special-clampf"
"@stdlib/complex/float64/base/mul","@stdlib/math-base-ops-cmul"
"@stdlib/complex/float32/base/mul","@stdlib/math-base-ops-cmulf"
"@stdlib/complex/float64/base/mul","@stdlib/complex-float64-base-mul"
"@stdlib/complex/float32/base/mul","@stdlib/complex-float32-base-mul"
"@stdlib/math/base/ops/cneg","@stdlib/math-base-ops-cneg"
"@stdlib/math/base/ops/cnegf","@stdlib/math-base-ops-cnegf"
"@stdlib/string/base/code-point-at","@stdlib/string-base-code-point-at"
Expand Down

Large diffs are not rendered by default.

Original file line number Diff line number Diff line change
Expand Up @@ -211,8 +211,8 @@
"@stdlib/math-base-special-cinv","@stdlib/math/base/special/cinv"
"@stdlib/math-base-special-clamp","@stdlib/math/base/special/clamp"
"@stdlib/math-base-special-clampf","@stdlib/math/base/special/clampf"
"@stdlib/math-base-ops-cmul","@stdlib/complex/float64/base/mul"
"@stdlib/math-base-ops-cmulf","@stdlib/complex/float32/base/mul"
"@stdlib/complex-float64-base-mul","@stdlib/complex/float64/base/mul"
"@stdlib/complex-float32-base-mul","@stdlib/complex/float32/base/mul"
"@stdlib/math-base-ops-cneg","@stdlib/math/base/ops/cneg"
"@stdlib/math-base-ops-cnegf","@stdlib/math/base/ops/cnegf"
"@stdlib/string-base-code-point-at","@stdlib/string/base/code-point-at"
Expand Down

Large diffs are not rendered by default.

3 changes: 3 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 @@ -2572,13 +2572,16 @@ BooleanArray.prototype.byteOffset,"var arr = new BooleanArray( 10 )\nvar offset
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.copyWithin,"var arr = new BooleanArray( [ true, false, false, true ] )\narr.copyWithin( 0, 2 )\nvar v = arr.get( 0 )\nv = arr.get( 1 )\n"
BooleanArray.prototype.entries,"var arr = new BooleanArray( [ true, false, true ] )\nvar it = arr.entries();\nvar v = it.next().value\nv = it.next().value\nv = it.next().value\nvar bool = it.next().done\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"
BooleanArray.prototype.findLastIndex,"function predicate( v ) { return v === true; };\nvar arr = new BooleanArray( [ true, false, true ] )\nvar idx = arr.findLastIndex( predicate )\n"
BooleanArray.prototype.forEach,"var str = '%';\nfunction clbk( v ) { str += v.toString() + '%'; };\nvar arr = new BooleanArray( [ true, false, false, true ] )\narr.forEach( clbk );\nstr\n"
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"
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.

5 changes: 4 additions & 1 deletion 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.

3 changes: 3 additions & 0 deletions lib/node_modules/@stdlib/repl/info/data/data.csv
Original file line number Diff line number Diff line change
Expand Up @@ -2572,13 +2572,16 @@ BooleanArray.prototype.byteOffset,"\nBooleanArray.prototype.byteOffset\n Offs
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.copyWithin,"\nBooleanArray.prototype.copyWithin( target, start[, end] )\n Copies a sequence of elements within the array starting at `start` and\n ending at `end` (non-inclusive) to the position starting at `target`.\n"
BooleanArray.prototype.entries,"\nBooleanArray.prototype.entries()\n Returns an iterator for iterating over array key-value pairs.\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"
BooleanArray.prototype.findLastIndex,"\nBooleanArray.prototype.findLastIndex( predicate:Function[, thisArg:Any] )\n Returns the index of the last element in an array for which a predicate\n function returns a truthy value.\n"
BooleanArray.prototype.forEach,"\nBooleanArray.prototype.forEach( clbk:Function[, thisArg:Any] )\n Invokes a function once for each array element.\n"
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"
Expand Down
2 changes: 1 addition & 1 deletion lib/node_modules/@stdlib/repl/info/data/data.json

Large diffs are not rendered by default.

3 changes: 3 additions & 0 deletions lib/node_modules/@stdlib/repl/signature/data/data.csv
Original file line number Diff line number Diff line change
Expand Up @@ -2578,13 +2578,16 @@ 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.copyWithin,"BooleanArray.prototype.copyWithin( target, start[, end] )"
BooleanArray.prototype.entries,"BooleanArray.prototype.entries()"
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] )"
BooleanArray.prototype.findLastIndex,"BooleanArray.prototype.findLastIndex( predicate[, thisArg] )"
BooleanArray.prototype.forEach,"BooleanArray.prototype.forEach( clbk[, thisArg] )"
BooleanArray.prototype.get,"BooleanArray.prototype.get( i )"
BooleanArray.prototype.includes,"BooleanArray.prototype.includes( searchElement[, fromIndex] )"
BooleanArray.prototype.indexOf,"BooleanArray.prototype.indexOf( searchElement[, fromIndex] )"
Expand Down
2 changes: 1 addition & 1 deletion lib/node_modules/@stdlib/repl/signature/data/data.json

Large diffs are not rendered by default.

3 changes: 3 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 @@ -2578,13 +2578,16 @@ 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.copyWithin,"BooleanArray.prototype.copyWithin( target, start[, end] )"
BooleanArray.prototype.entries,"BooleanArray.prototype.entries()"
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] )"
BooleanArray.prototype.findLastIndex,"BooleanArray.prototype.findLastIndex( predicate:Function[, thisArg:Any] )"
BooleanArray.prototype.forEach,"BooleanArray.prototype.forEach( clbk:Function[, thisArg:Any] )"
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] )"
Expand Down

Large diffs are not rendered by default.

1 comment on commit c89a171

@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
namespace/alias2standalone $\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\%$
namespace/pkg2standalone $\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\%$
namespace/standalone2pkg $\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/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.