docs: update REPL namespace documentation

PR-URL: #10585

Co-authored-by: Philipp Burckhardt <pburckhardt@outlook.com>
Reviewed-by: Philipp Burckhardt <pburckhardt@outlook.com>
Signed-off-by: stdlib-bot <82920195+stdlib-bot@users.noreply.github.com>

Author: stdlib-bot

lib/node_modules/@stdlib/repl/code-blocks/data/data.csv

@@ -2541,7 +2541,7 @@ base.toBinaryStringUint32,"var a = new Uint32Array( [ 1, 4, 9 ] );\nvar str = ba
 base.toWordf,"var f32 = base.float64ToFloat32( 1.337 )\nvar w = base.toWordf( f32 )\n"
 base.toWords,"var w = base.toWords( 3.14e201 )\n"
 base.toWords.assign,"var out = new Uint32Array( 2 );\nvar w = base.toWords.assign( 3.14e201, out, 1, 0 )\nvar bool = ( w === out )\n"
-base.transpose,"var x = array( [ [ 1, 2, 3 ], [ 4, 5, 6 ] ] )\nvar sh = x.shape\nvar y = base.transpose( x )\nsh = y.shape\nvar bool = ( x.data === y.data )\nbool = ( x.get( 0, 1 ) === y.get( 1, 0 ) )\n"
+base.transpose,"var x = array( [ [ 1, 2, 3 ], [ 4, 5, 6 ] ] )\nvar y = base.transpose( x, false )\n"
 base.tribonacci,"var y = base.tribonacci( 0 )\ny = base.tribonacci( 1 )\ny = base.tribonacci( 2 )\ny = base.tribonacci( 3 )\ny = base.tribonacci( 4 )\ny = base.tribonacci( 64 )\ny = base.tribonacci( NaN )\n"
 base.trigamma,"var y = base.trigamma( -2.5 )\ny = base.trigamma( 1.0 )\ny = base.trigamma( 10.0 )\ny = base.trigamma( NaN )\ny = base.trigamma( -1.0 )\n"
 base.trim,"var out = base.trim( ' \t\t\n  Beep \r\n\t  ' )\n"

lib/node_modules/@stdlib/repl/code-blocks/data/data.json

@@ -2541,7 +2541,7 @@ base.toBinaryStringUint32,"\nbase.toBinaryStringUint32( x )\n    Returns a strin
 base.toWordf,"\nbase.toWordf( x )\n    Returns an unsigned 32-bit integer corresponding to the IEEE 754 binary\n    representation of a single-precision floating-point number.\n\n    Parameters\n    ----------\n    x: float\n        Single-precision floating-point number.\n\n    Returns\n    -------\n    out: integer\n        Unsigned 32-bit integer.\n\n    Examples\n    --------\n    > var f32 = base.float64ToFloat32( 1.337 )\n    1.3370000123977661\n    > var w = base.toWordf( f32 )\n    1068180177\n\n    See Also\n    --------\n    base.fromWordf, base.toWords\n"
 base.toWords,"\nbase.toWords( x )\n    Splits a double-precision floating-point number into a higher order word\n    (unsigned 32-bit integer) and a lower order word (unsigned 32-bit integer).\n\n    When provided a destination object, the function returns an array with two\n    elements: a higher order word and a lower order word, respectively. The\n    lower order word contains the less significant bits, while the higher order\n    word contains the more significant bits and includes the exponent and sign.\n\n    Parameters\n    ----------\n    x: number\n        Double-precision floating-point number.\n\n    Returns\n    -------\n    out: Array<integer>\n        Higher and lower order words.\n\n    Examples\n    --------\n    > var w = base.toWords( 3.14e201 )\n    [ 1774486211, 2479577218 ]\n\n\nbase.toWords.assign( x, out, stride, offset )\n    Splits a double-precision floating-point number into a higher order word\n    (unsigned 32-bit integer) and a lower order word (unsigned 32-bit integer)\n    and assigns results to a provided output array.\n\n    When provided a destination object, the function returns an array with two\n    elements: a higher order word and a lower order word, respectively. The\n    lower order word contains the less significant bits, while the higher order\n    word contains the more significant bits and includes the exponent and sign.\n\n    Parameters\n    ----------\n    x: number\n        Double-precision floating-point number.\n\n    out: Array|TypedArray|Object\n        Output array.\n\n    stride: integer\n        Output array stride.\n\n    offset: integer\n        Output array index offset.\n\n    Returns\n    -------\n    out: Array|TypedArray|Object\n        Higher and lower order words.\n\n    Examples\n    --------\n    > var out = new Uint32Array( 2 );\n    > var w = base.toWords.assign( 3.14e201, out, 1, 0 )\n    <Uint32Array>[ 1774486211, 2479577218 ]\n    > var bool = ( w === out )\n    true\n\n    See Also\n    --------\n    base.fromWords, base.toWordf"
 base.toWords.assign,"\nbase.toWords.assign( x, out, stride, offset )\n    Splits a double-precision floating-point number into a higher order word\n    (unsigned 32-bit integer) and a lower order word (unsigned 32-bit integer)\n    and assigns results to a provided output array.\n\n    When provided a destination object, the function returns an array with two\n    elements: a higher order word and a lower order word, respectively. The\n    lower order word contains the less significant bits, while the higher order\n    word contains the more significant bits and includes the exponent and sign.\n\n    Parameters\n    ----------\n    x: number\n        Double-precision floating-point number.\n\n    out: Array|TypedArray|Object\n        Output array.\n\n    stride: integer\n        Output array stride.\n\n    offset: integer\n        Output array index offset.\n\n    Returns\n    -------\n    out: Array|TypedArray|Object\n        Higher and lower order words.\n\n    Examples\n    --------\n    > var out = new Uint32Array( 2 );\n    > var w = base.toWords.assign( 3.14e201, out, 1, 0 )\n    <Uint32Array>[ 1774486211, 2479577218 ]\n    > var bool = ( w === out )\n    true\n\n    See Also\n    --------\n    base.fromWords, base.toWordf"
-base.transpose,"\nbase.transpose( x )\n    Transposes a matrix (or a stack of matrices).\n\n    The returned ndarray is a *view* of the input ndarray. Accordingly, writing\n    to the original ndarray will mutate the returned ndarray and vice versa.\n    While powerful, this can lead to subtle bugs. In general, one should handle\n    the returned ndarray as read-only.\n\n    If provided an ndarray with fewer than two dimensions, the function raises\n    an exception.\n\n    Parameters\n    ----------\n    x: ndarray\n        Input array.\n\n    Returns\n    -------\n    out: ndarray\n        Output array.\n\n    Examples\n    --------\n    > var x = array( [ [ 1, 2, 3 ], [ 4, 5, 6 ] ] )\n    <ndarray>\n    > var sh = x.shape\n    [ 2, 3 ]\n    > var y = base.transpose( x )\n    <ndarray>\n    > sh = y.shape\n    [ 3, 2 ]\n    > var bool = ( x.data === y.data )\n    true\n    > bool = ( x.get( 0, 1 ) === y.get( 1, 0 ) )\n    true\n\n    See Also\n    --------\n    ndarray\n"
+base.transpose,"\nbase.transpose( x, writable )\n    Transposes a matrix (or a stack of matrices).\n\n    The returned ndarray is a *view* of the input ndarray. Accordingly, writing\n    to the original ndarray will mutate the returned ndarray and vice versa.\n\n    The `writable` parameter only applies to ndarray constructors supporting\n    read-only instances.\n\n    If provided an ndarray with fewer than two dimensions, the function raises\n    an exception.\n\n    Parameters\n    ----------\n    x: ndarray\n        Input array.\n\n    writable: boolean\n        Boolean indicating whether the returned ndarray should be writable.\n\n    Returns\n    -------\n    out: ndarray\n        Output array.\n\n    Examples\n    --------\n    > var x = array( [ [ 1, 2, 3 ], [ 4, 5, 6 ] ] )\n    <ndarray>[ [ 1, 2, 3 ], [ 4, 5, 6 ] ]\n    > var y = base.transpose( x, false )\n    <ndarray>[ [ 1, 4 ], [ 2, 5 ], [ 3, 6 ] ]\n\n    See Also\n    --------\n    ndarray\n"
 base.tribonacci,"\nbase.tribonacci( n )\n    Computes the nth Tribonacci number.\n\n    Tribonacci numbers follow the recurrence relation\n\n      F_n = F_{n-1} + F_{n-2} + F_{n-3}\n\n    with seed values F_0 = 0, F_1 = 0, and F_2 = 1.\n\n    If `n` is greater than `63`, the function returns `NaN`, as larger\n    Tribonacci numbers cannot be accurately represented due to limitations of\n    double-precision floating-point format.\n\n    If not provided a nonnegative integer value, the function returns `NaN`.\n\n    If provided `NaN`, the function returns `NaN`.\n\n    Parameters\n    ----------\n    n: integer\n        Input value.\n\n    Returns\n    -------\n    y: integer\n        Tribonacci number.\n\n    Examples\n    --------\n    > var y = base.tribonacci( 0 )\n    0\n    > y = base.tribonacci( 1 )\n    0\n    > y = base.tribonacci( 2 )\n    1\n    > y = base.tribonacci( 3 )\n    1\n    > y = base.tribonacci( 4 )\n    2\n    > y = base.tribonacci( 64 )\n    NaN\n    > y = base.tribonacci( NaN )\n    NaN\n\n    See Also\n    --------\n    base.fibonacci\n"
 base.trigamma,"\nbase.trigamma( x )\n    Evaluates the trigamma function.\n\n    If `x` is `0` or a negative `integer`, the `function` returns `NaN`.\n\n    If provided `NaN`, the `function` returns `NaN`.\n\n    Parameters\n    ----------\n    x: number\n        Input value.\n\n    Returns\n    -------\n    y: number\n        Function value.\n\n    Examples\n    --------\n    > var y = base.trigamma( -2.5 )\n    ~9.539\n    > y = base.trigamma( 1.0 )\n    ~1.645\n    > y = base.trigamma( 10.0 )\n    ~0.105\n    > y = base.trigamma( NaN )\n    NaN\n    > y = base.trigamma( -1.0 )\n    NaN\n\n    See Also\n    --------\n    base.digamma, base.gamma\n"
 base.trim,"\nbase.trim( str )\n    Trims whitespace from the beginning and end of a `string`.\n\n    \"Whitespace\" is defined as the following characters:\n\n    - \f\n    - \n\n    - \r\n    - \t\n    - \v\n    - \u0020\n    - \u00a0\n    - \u1680\n    - \u2000-\u200a\n    - \u2028\n    - \u2029\n    - \u202f\n    - \u205f\n    - \u3000\n    - \ufeff\n\n    Parameters\n    ----------\n    str: string\n        Input string.\n\n    Returns\n    -------\n    out: string\n        Trimmed string.\n\n    Examples\n    --------\n    > var out = base.trim( ' \t\t\n  Beep \r\n\t  ' )\n    'Beep'\n\n    See Also\n    --------\n    base.leftTrim, base.rightTrim\n"

lib/node_modules/@stdlib/repl/help/data/data.csv

@@ -2541,7 +2541,7 @@ base.toBinaryStringUint32,"\nbase.toBinaryStringUint32( x:integer )\n    Returns
 base.toWordf,"\nbase.toWordf( x:float )\n    Returns an unsigned 32-bit integer corresponding to the IEEE 754 binary\n    representation of a single-precision floating-point number.\n"
 base.toWords,"\nbase.toWords( x:number )\n    Splits a double-precision floating-point number into a higher order word\n    (unsigned 32-bit integer) and a lower order word (unsigned 32-bit integer).\n"
 base.toWords.assign,"\nbase.toWords.assign( x:number, out:Array|TypedArray|Object, stride:integer, \n  offset:integer )\n    Splits a double-precision floating-point number into a higher order word\n    (unsigned 32-bit integer) and a lower order word (unsigned 32-bit integer)\n    and assigns results to a provided output array.\n"
-base.transpose,"\nbase.transpose( x:ndarray )\n    Transposes a matrix (or a stack of matrices).\n"
+base.transpose,"\nbase.transpose( x:ndarray, writable:boolean )\n    Transposes a matrix (or a stack of matrices).\n"
 base.tribonacci,"\nbase.tribonacci( n:integer )\n    Computes the nth Tribonacci number.\n"
 base.trigamma,"\nbase.trigamma( x:number )\n    Evaluates the trigamma function.\n"
 base.trim,"\nbase.trim( str:string )\n    Trims whitespace from the beginning and end of a `string`.\n"

lib/node_modules/@stdlib/repl/help/data/data.json

@@ -2541,7 +2541,7 @@ base.toBinaryStringUint32,"base.toBinaryStringUint32( x )"
 base.toWordf,"base.toWordf( x )"
 base.toWords,"base.toWords( x )"
 base.toWords.assign,"base.toWords.assign( x, out, stride, offset )"
-base.transpose,"base.transpose( x )"
+base.transpose,"base.transpose( x, writable )"
 base.tribonacci,"base.tribonacci( n )"
 base.trigamma,"base.trigamma( x )"
 base.trim,"base.trim( str )"

lib/node_modules/@stdlib/repl/info/data/data.csv

@@ -2541,7 +2541,7 @@ base.toBinaryStringUint32,"base.toBinaryStringUint32( x:integer )"
 base.toWordf,"base.toWordf( x:float )"
 base.toWords,"base.toWords( x:number )"
 base.toWords.assign,"base.toWords.assign( x:number, out:Array|TypedArray|Object, stride:integer, offset:integer )"
-base.transpose,"base.transpose( x:ndarray )"
+base.transpose,"base.transpose( x:ndarray, writable:boolean )"
 base.tribonacci,"base.tribonacci( n:integer )"
 base.trigamma,"base.trigamma( x:number )"
 base.trim,"base.trim( str:string )"