Skip to content

Commit

Permalink
docs: update REPL namespace documentation
Browse files Browse the repository at this point in the history
PR-URL: #2501
Co-authored-by: Athan Reines <[email protected]>
Reviewed-by: Athan Reines <[email protected]> 
Signed-off-by: stdlib-bot <[email protected]>
  • Loading branch information
stdlib-bot and kgryte authored Jul 3, 2024
1 parent 48fd331 commit 77ecc3a
Show file tree
Hide file tree
Showing 2 changed files with 2 additions and 2 deletions.
2 changes: 1 addition & 1 deletion lib/node_modules/@stdlib/repl/help/data/data.csv
Original file line number Diff line number Diff line change
Expand Up @@ -2743,7 +2743,7 @@ constantStream.objectMode,"\nconstantStream.objectMode( value[, options] )\n
constructorName,"\nconstructorName( val )\n Determines the name of a value's constructor.\n\n Parameters\n ----------\n val: any\n Input value.\n\n Returns\n -------\n out: string\n Name of a value's constructor.\n\n Examples\n --------\n > var v = constructorName( 'a' )\n 'String'\n > v = constructorName( {} )\n 'Object'\n > v = constructorName( true )\n 'Boolean'\n\n See Also\n --------\n functionName\n"
contains,"\ncontains( val, searchValue[, position] )\n Tests if an array-like value contains a search value.\n\n When `val` is a string, the function checks whether the characters of the\n search string are found in the input string. The search is case-sensitive.\n\n When `val` is an array-like object, the function checks whether the input\n array contains an element strictly equal to the specified search value.\n\n For strings, this function is modeled after `String.prototype.includes`,\n part of the ECMAScript 6 specification. This function is different from a\n call to `String.prototype.includes.call` insofar as type-checking is\n performed for all arguments.\n\n The function does not distinguish between positive and negative zero.\n\n If `position < 0`, the search is performed for the entire input array or\n string.\n\n\n Parameters\n ----------\n val: ArrayLike\n Input value.\n\n searchValue: any\n Value to search for.\n\n position: integer (optional)\n Position at which to start searching for `searchValue`. Default: `0`.\n\n Returns\n -------\n bool: boolean\n Boolean indicating if an input value contains another value.\n\n Examples\n --------\n > var bool = contains( 'Hello World', 'World' )\n true\n > bool = contains( 'Hello World', 'world' )\n false\n > bool = contains( [ 1, 2, 3, 4 ], 2 )\n true\n > bool = contains( [ NaN, 2, 3, 4 ], NaN )\n true\n\n // Supply a position:\n > bool = contains( 'Hello World', 'Hello', 6 )\n false\n > bool = contains( [ true, NaN, false ], true, 1 )\n false\n\n"
convertArray,"\nconvertArray( arr, dtype )\n Converts an input array to an array of a different data type.\n\n Parameters\n ----------\n arr: ArrayLikeObject\n Array to convert.\n\n dtype: string\n Output data type.\n\n Returns\n -------\n out: Array|TypedArray\n Output array.\n\n Examples\n --------\n > var arr = [ 1.0, 2.0, 3.0, 4.0 ];\n > var out = convertArray( arr, 'float32' )\n <Float32Array>[ 1.0, 2.0, 3.0, 4.0 ]\n\n See Also\n --------\n convertArraySame\n"
convertArraySame,"\nconvertArraySame( x, y )\n Converts an input array to the same data type as a second input array.\n\n The function supports input arrays having the following data types:\n\n - float32: single-precision floating-point numbers.\n - float64: double-precision floating-point numbers.\n - complex64: single-precision complex floating-point numbers.\n - complex128: double-precision complex floating-point numbers.\n - generic: values of any type.\n - int16: signed 16-bit integers.\n - int32: signed 32-bit integers.\n - int8: signed 8-bit integers.\n - uint16: unsigned 16-bit integers.\n - uint32: unsigned 32-bit integers.\n - uint8: unsigned 8-bit integers.\n - uint8c: unsigned clamped 8-bit integers.\n\n Parameters\n ----------\n x: ArrayLikeObject\n Array to convert.\n\n y: Array|TypedArray\n Array having desired output data type.\n\n Returns\n -------\n out: Array|TypedArray\n Output array.\n\n Examples\n --------\n > var x = [ 1.0, 2.0, 3.0, 4.0 ];\n > var y = new Float32Array( 0 );\n > var out = convertArraySame( x, y )\n <Float32Array>[ 1.0, 2.0, 3.0, 4.0 ]\n\n See Also\n --------\n convertArray\n"
convertArraySame,"\nconvertArraySame( x, y )\n Converts an input array to the same data type as a second input array.\n\n Parameters\n ----------\n x: ArrayLikeObject\n Array to convert.\n\n y: Array|TypedArray\n Array having desired output data type.\n\n Returns\n -------\n out: Array|TypedArray\n Output array.\n\n Examples\n --------\n > var x = [ 1.0, 2.0, 3.0, 4.0 ];\n > var y = new Float32Array( 0 );\n > var out = convertArraySame( x, y )\n <Float32Array>[ 1.0, 2.0, 3.0, 4.0 ]\n\n See Also\n --------\n convertArray\n"
convertPath,"\nconvertPath( from, to )\n Converts between POSIX and Windows paths.\n\n Parameters\n ----------\n from: string\n Input path.\n\n to: string\n Output path convention: 'win32', 'mixed', or 'posix'.\n\n Returns\n -------\n out: string\n Converted path.\n\n Examples\n --------\n > var out = convertPath( '/c/foo/bar/beep.c', 'win32' )\n 'c:\\foo\\bar\\beep.c'\n > out = convertPath( '/c/foo/bar/beep.c', 'mixed' )\n 'c:/foo/bar/beep.c'\n > out = convertPath( '/c/foo/bar/beep.c', 'posix' )\n '/c/foo/bar/beep.c'\n > out = convertPath( 'C:\\\\foo\\bar\\beep.c', 'win32' )\n 'C:\\\\foo\\bar\\beep.c'\n > out = convertPath( 'C:\\\\foo\\bar\\beep.c', 'mixed' )\n 'C:/foo/bar/beep.c'\n > out = convertPath( 'C:\\\\foo\\bar\\beep.c', 'posix' )\n '/c/foo/bar/beep.c'\n\n"
copy,"\ncopy( value[, level] )\n Copy or deep clone a value to an arbitrary depth.\n\n The implementation can handle circular references.\n\n If a `Number`, `String`, or `Boolean` object is encountered, the value is\n cloned as a primitive. This behavior is intentional.\n\n For objects, the implementation only copies enumerable keys and their\n associated property descriptors.\n\n The implementation only checks whether basic `Objects`, `Arrays`, and class\n instances are extensible, sealed, and/or frozen.\n\n Functions are not cloned; their reference is copied.\n\n The implementation supports custom error types which are `Error` instances\n (e.g., ES2015 subclasses).\n\n Support for copying class instances is inherently fragile. Any instances\n with privileged access to variables (e.g., within closures) cannot be\n cloned. This stated, basic copying of class instances is supported. Provided\n an environment which supports ES5, the implementation is greedy and performs\n a deep clone of any arbitrary class instance and its properties. The\n implementation assumes that the concept of `level` applies only to the class\n instance reference, but not to its internal state.\n\n Parameters\n ----------\n value: any\n Value to test.\n\n level: integer (optional)\n Copy depth. Default: Infinity.\n\n Returns\n -------\n out: any\n Value copy.\n\n Examples\n --------\n > var value = [ { 'a': 1, 'b': true, 'c': [ 1, 2, 3 ] } ];\n > var out = copy( value )\n [ { 'a': 1, 'b': true, 'c': [ 1, 2, 3 ] } ]\n > var bool = ( value[ 0 ].c === out[ 0 ].c )\n false\n\n // Set the `level` option to limit the copy depth:\n > value = [ { 'a': 1, 'b': true, 'c': [ 1, 2, 3 ] } ];\n > out = copy( value, 1 );\n > bool = ( value[ 0 ] === out[ 0 ] )\n true\n > bool = ( value[ 0 ].c === out[ 0 ].c )\n true\n\n\n See Also\n --------\n merge\n"
copyBuffer,"\ncopyBuffer( buffer )\n Copies buffer data to a new Buffer instance.\n\n Parameters\n ----------\n buffer: Buffer\n Buffer to copy from.\n\n Returns\n -------\n out: Buffer\n Buffer instance.\n\n Examples\n --------\n > var b1 = array2buffer( [ 1, 2, 3, 4 ] );\n > var b2 = copyBuffer( b1 )\n <Buffer>[ 1, 2, 3, 4 ]\n\n See Also\n --------\n allocUnsafe, Buffer\n"
Expand Down
2 changes: 1 addition & 1 deletion lib/node_modules/@stdlib/repl/help/data/data.json

Large diffs are not rendered by default.

1 comment on commit 77ecc3a

@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/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\%$

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

Please sign in to comment.