Auto-generated commit

CHANGELOG.md

@@ -270,6 +270,7 @@ A total of 9 people contributed to this release. Thank you to the following cont
 
 <details>
 
+-   [`d2d46ed`](https://github.com/stdlib-js/stdlib/commit/d2d46ed18a02ef8c87a8a896c4bd4b46343a631b) - **docs:** update REPL namespace documentation [(#2492)](https://github.com/stdlib-js/stdlib/pull/2492) _(by stdlib-bot, Athan Reines)_
 -   [`bdb7cab`](https://github.com/stdlib-js/stdlib/commit/bdb7cab0555da6d3402470aee39cdb31b7a447bd) - **docs:** update REPL namespace documentation [(#2491)](https://github.com/stdlib-js/stdlib/pull/2491) _(by stdlib-bot, Athan Reines)_
 -   [`1d49bc6`](https://github.com/stdlib-js/stdlib/commit/1d49bc691bce0634e7b0508ff495fca733c48a4c) - **feat:** add UX to cycle through completions in the REPL [(#2463)](https://github.com/stdlib-js/stdlib/pull/2463) _(by Snehil Shah, Athan Reines)_
 -   [`581f17e`](https://github.com/stdlib-js/stdlib/commit/581f17e69ee0eb47edc2991a3e80581f7e0af338) - **docs:** update REPL namespace documentation [(#2476)](https://github.com/stdlib-js/stdlib/pull/2476) _(by stdlib-bot, Athan Reines)_

help/data/data.csv

@@ -2742,7 +2742,7 @@ constantStream.factory,"\nconstantStream.factory( [value, ][options] )\n    Retu
 constantStream.objectMode,"\nconstantStream.objectMode( value[, options] )\n    Returns an \"objectMode\" readable stream which always streams the same value.\n\n    In object mode, `null` is a reserved value. If provided `null`, the\n    returned stream will prematurely end.\n\n    Parameters\n    ----------\n    value: any\n        Value to stream.\n\n    options: Object (optional)\n        Options.\n\n    options.encoding: string|null (optional)\n        Specifies how Buffer objects should be decoded to strings. Default:\n        null.\n\n    options.highWaterMark: integer (optional)\n        Specifies the maximum number of objects to store in an internal buffer\n        before pausing streaming.\n\n    options.iter: integer (optional)\n        Number of iterations.\n\n    Returns\n    -------\n    stream: ReadableStream\n        Readable stream operating in \"objectMode\".\n\n    Examples\n    --------\n    > function fcn( v ) { console.log( v ); };\n    > var opts = { 'iter': 10 };\n    > var s = constantStream.objectMode( 3.14, opts );\n    > var o = inspectSinkStream.objectMode( fcn );\n    > s.pipe( o );\n\n    See Also\n    --------\n    arrayStream, iteratorStream"
 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    The function supports 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    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"
+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"
 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"