docs: update REPL namespace documentation

PR-URL: #10794

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

@@ -2808,7 +2808,7 @@ dayOfQuarter,"var day = dayOfQuarter()\nday = dayOfQuarter( new Date() )\nday =
 dayOfYear,"var day = dayOfYear()\nday = dayOfYear( new Date() )\nday = dayOfYear( 12, 31, 2016 )\nday = dayOfYear( 'dec', 31, 2016 )\nday = dayOfYear( 'december', 31, 2016 )\n"
 daysInMonth,"var num = daysInMonth()\nnum = daysInMonth( 2 )\nnum = daysInMonth( 2, 2016 )\nnum = daysInMonth( 2, 2017 )\nnum = daysInMonth( 'feb', 2016 )\nnum = daysInMonth( 'february', 2016 )\n"
 daysInYear,"var num = daysInYear()\nnum = daysInYear( 2016 )\nnum = daysInYear( 2017 )\n"
-ddot,"var xbuf = new Float64Array( [ 4.0, 2.0, -3.0, 5.0, -1.0 ] );\nvar x = array( xbuf );\nvar ybuf = new Float64Array( [ 2.0, 6.0, -1.0, -4.0, 8.0 ] );\nvar y = array( ybuf );\nvar z = ddot( x, y )\nz.get()\n"
+ddot,"var xbuf = new Float64Array( [ 4.0, 2.0, -3.0, 5.0, -1.0 ] );\nvar x = array( xbuf );\nvar ybuf = new Float64Array( [ 2.0, 6.0, -1.0, -4.0, 8.0 ] );\nvar y = array( ybuf );\nvar z = ddot( x, y )\n"
 debugSinkStream,"var s = debugSinkStream( { 'name': 'foo' } );\ns.write( 'a' );\ns.write( 'b' );\ns.write( 'c' );\ns.end();\n"
 debugSinkStream.factory,"var opts = { 'objectMode': true, 'highWaterMark': 64 };\nvar createStream = debugSinkStream.factory( opts );\n"
 debugSinkStream.objectMode,"var s = debugSinkStream.objectMode( { 'name': 'foo' } );\ns.write( { 'value': 'a' } );\ns.write( { 'value': 'b' } );\ns.write( { 'value': 'c' } );\ns.end();\n"

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

@@ -2809,7 +2809,7 @@ dayOfQuarter,"\ndayOfQuarter( [month[, day, year]] )\n    Returns the day of the
 dayOfYear,"\ndayOfYear( [month[, day, year]] )\n    Returns the day of the year.\n\n    By default, the function returns the day of the year for the current date\n    (according to local time). To determine the day of the year for a particular\n    day, provide `month`, `day`, and `year` arguments.\n\n    A `month` may be either a month's integer value, three letter abbreviation,\n    or full name (case insensitive).\n\n    The function also accepts a `Date` object.\n\n    Parameters\n    ----------\n    month: string|integer|Date (optional)\n        Month (or `Date`).\n\n    day: integer (optional)\n        Day.\n\n    year: integer (optional)\n        Year.\n\n    Returns\n    -------\n    out: integer\n        Day of the year.\n\n    Examples\n    --------\n    > var day = dayOfYear()\n    <number>\n    > day = dayOfYear( new Date() )\n    <number>\n    > day = dayOfYear( 12, 31, 2016 )\n    366\n\n    // Other ways to supply month:\n    > day = dayOfYear( 'dec', 31, 2016 )\n    366\n    > day = dayOfYear( 'december', 31, 2016 )\n    366\n\n    See Also\n    --------\n    dayOfQuarter\n"
 daysInMonth,"\ndaysInMonth( [month[, year]] )\n    Returns the number of days in a month.\n\n    By default, the function returns the number of days in the current month\n    of the current year (according to local time). To determine the number of\n    days for a particular month and year, provide `month` and `year` arguments.\n\n    A `month` may be either a month's integer value, three letter abbreviation,\n    or full name (case insensitive).\n\n    The function's return value is a generalization and does **not** take into\n    account inaccuracies due to daylight savings conventions, crossing\n    timezones, or other complications with time and dates.\n\n    Parameters\n    ----------\n    month: string|integer|Date (optional)\n        Month (or `Date`).\n\n    year: integer (optional)\n        Year.\n\n    Returns\n    -------\n    out: integer\n        Days in a month.\n\n    Examples\n    --------\n    > var num = daysInMonth()\n    <number>\n    > num = daysInMonth( 2 )\n    <number>\n    > num = daysInMonth( 2, 2016 )\n    29\n    > num = daysInMonth( 2, 2017 )\n    28\n\n    // Other ways to supply month:\n    > num = daysInMonth( 'feb', 2016 )\n    29\n    > num = daysInMonth( 'february', 2016 )\n    29\n\n    See Also\n    --------\n    daysInYear\n"
 daysInYear,"\ndaysInYear( [value] )\n    Returns the number of days in a year according to the Gregorian calendar.\n\n    By default, the function returns the number of days in the current year\n    (according to local time). To determine the number of days for a particular\n    year, provide either a year or a `Date` object.\n\n    The function's return value is a generalization and does **not** take into\n    account inaccuracies due to daylight savings conventions, crossing\n    timezones, or other complications with time and dates.\n\n    Parameters\n    ----------\n    value: integer|Date (optional)\n        Year or `Date` object.\n\n    Returns\n    -------\n    out: integer\n        Number of days in a year.\n\n    Examples\n    --------\n    > var num = daysInYear()\n    <number>\n    > num = daysInYear( 2016 )\n    366\n    > num = daysInYear( 2017 )\n    365\n\n    See Also\n    --------\n    daysInMonth\n"
-ddot,"\nddot( x, y[, dim] )\n    Computes the dot product of two double-precision floating-point vectors.\n\n    If provided at least one input array having more than one dimension, the\n    input arrays are broadcasted to a common shape.\n\n    For multi-dimensional input arrays, the function performs batched\n    computation, such that the function computes the dot product for each pair\n    of vectors in `x` and `y` according to the specified dimension index.\n\n    The size of the contracted dimension must be the same for both input arrays.\n\n    The function resolves the dimension index for which to compute the dot\n    product *before* broadcasting.\n\n    If provided empty vectors, the dot product is `0`.\n\n    Parameters\n    ----------\n    x: ndarray\n        First input array. Must have a 'float64' data type. Must have at least\n        one dimension and be broadcast-compatible with the second input array.\n\n    y: ndarray\n        Second input array. Must have a 'float64' data type. Must have at least\n        one dimension and be broadcast-compatible with the first input array.\n\n    dim: integer (optional)\n        Dimension index for which to compute the dot product. Must be a negative\n        integer. Negative indices are resolved relative to the last array\n        dimension, with the last dimension corresponding to `-1`. Default: -1.\n\n    Returns\n    -------\n    out: ndarray\n        The dot product. The output array has the same data type as the input\n        arrays and has a shape which is determined by broadcasting and excludes\n        the contracted dimension.\n\n    Examples\n    --------\n    > var xbuf = new Float64Array( [ 4.0, 2.0, -3.0, 5.0, -1.0 ] );\n    > var x = array( xbuf );\n    > var ybuf = new Float64Array( [ 2.0, 6.0, -1.0, -4.0, 8.0 ] );\n    > var y = array( ybuf );\n    > var z = ddot( x, y )\n    <ndarray>\n    > z.get()\n    -5.0\n\n    See Also\n    --------\n    base.strided.ddot, gdot, sdot\n"
+ddot,"\nddot( x, y[, dim] )\n    Computes the dot product of two double-precision floating-point vectors.\n\n    If provided at least one input array having more than one dimension, the\n    input arrays are broadcasted to a common shape.\n\n    For multi-dimensional input arrays, the function performs batched\n    computation, such that the function computes the dot product for each pair\n    of vectors in `x` and `y` according to the specified dimension index.\n\n    The size of the contracted dimension must be the same for both input arrays.\n\n    The function resolves the dimension index for which to compute the dot\n    product *before* broadcasting.\n\n    If provided empty vectors, the dot product is `0`.\n\n    Parameters\n    ----------\n    x: ndarray\n        First input array. Must have a 'float64' data type. Must have at least\n        one dimension and be broadcast-compatible with the second input array.\n\n    y: ndarray\n        Second input array. Must have a 'float64' data type. Must have at least\n        one dimension and be broadcast-compatible with the first input array.\n\n    dim: integer (optional)\n        Dimension index for which to compute the dot product. Must be a negative\n        integer. Negative indices are resolved relative to the last array\n        dimension, with the last dimension corresponding to `-1`. Default: -1.\n\n    Returns\n    -------\n    out: ndarray\n        The dot product. The output array has the same data type as the input\n        arrays and has a shape which is determined by broadcasting and excludes\n        the contracted dimension.\n\n    Examples\n    --------\n    > var xbuf = new Float64Array( [ 4.0, 2.0, -3.0, 5.0, -1.0 ] );\n    > var x = array( xbuf );\n    > var ybuf = new Float64Array( [ 2.0, 6.0, -1.0, -4.0, 8.0 ] );\n    > var y = array( ybuf );\n    > var z = ddot( x, y )\n    <ndarray>[ -5.0 ]\n\n    See Also\n    --------\n    base.strided.ddot, gdot, sdot\n"
 debugSinkStream,"\ndebugSinkStream( [options,] [clbk] )\n    Returns a writable stream for debugging stream pipelines.\n\n    If the `DEBUG` environment variable is not set, no data is logged.\n\n    Providing a `name` option is *strongly* encouraged, as the `DEBUG`\n    environment variable can be used to filter debuggers.\n\n    Parameters\n    ----------\n    options: Object (optional)\n        Options.\n\n    options.name: string (optional)\n        Debug namespace.\n\n    options.objectMode: boolean (optional)\n        Specifies whether a stream should operate in \"objectMode\". Default:\n        false.\n\n    options.highWaterMark: integer (optional)\n        Specifies the maximum number of bytes to store in an internal buffer\n        before ceasing to push downstream.\n\n    options.decodeStrings: boolean (optional)\n        Specifies whether to encode strings as `Buffer` objects before writing\n        data to a returned stream. Default: true.\n\n    options.defaultEncoding: string (optional)\n        Default encoding when not explicitly specified when writing data.\n        Default: 'utf8'.\n\n    clbk: Function (optional)\n        Callback to invoke upon receiving data.\n\n    Returns\n    -------\n    stream: WritableStream\n        Writable stream.\n\n    Examples\n    --------\n    > var s = debugSinkStream( { 'name': 'foo' } );\n    > s.write( 'a' );\n    > s.write( 'b' );\n    > s.write( 'c' );\n    > s.end();\n\n\ndebugSinkStream.factory( [options] )\n    Returns a function for creating writable streams for debugging stream\n    pipelines.\n\n    Parameters\n    ----------\n    options: Object (optional)\n        Options.\n\n    options.objectMode: boolean (optional)\n        Specifies whether a stream should operate in \"objectMode\". Default:\n        false.\n\n    options.highWaterMark: integer (optional)\n        Specifies the maximum number of bytes to store in an internal buffer\n        before ceasing to push downstream.\n\n    options.decodeStrings: boolean (optional)\n        Specifies whether to encode strings as `Buffer` objects before writing\n        data to a returned stream. Default: true.\n\n    options.defaultEncoding: string (optional)\n        Default encoding when not explicitly specified when writing data.\n        Default: 'utf8'.\n\n    Returns\n    -------\n    createStream( name[, clbk] ): Function\n        Function for creating writable streams.\n\n    Examples\n    --------\n    > var opts = { 'objectMode': true, 'highWaterMark': 64 };\n    > var createStream = debugSinkStream.factory( opts );\n\n\ndebugSinkStream.objectMode( [options,] [clbk] )\n    Returns an \"objectMode\" writable stream for debugging stream pipelines.\n\n    Parameters\n    ----------\n    options: Object (optional)\n        Options.\n\n    options.name: string (optional)\n        Debug namespace.\n\n    options.highWaterMark: integer (optional)\n        Specifies the maximum number of objects to store in an internal buffer\n        before ceasing to push downstream.\n\n    options.decodeStrings: boolean (optional)\n        Specifies whether to encode strings as `Buffer` objects before writing\n        data to a returned stream. Default: true.\n\n    options.defaultEncoding: string (optional)\n        Default encoding when not explicitly specified when writing data.\n        Default: 'utf8'.\n\n    clbk: Function (optional)\n        Callback to invoke upon receiving data.\n\n    Returns\n    -------\n    stream: WritableStream\n        Writable stream operating in \"objectMode\".\n\n    Examples\n    --------\n    > var s = debugSinkStream.objectMode( { 'name': 'foo' } );\n    > s.write( { 'value': 'a' } );\n    > s.write( { 'value': 'b' } );\n    > s.write( { 'value': 'c' } );\n    > s.end();\n\n    See Also\n    --------\n    debugStream, inspectSinkStream\n"
 debugSinkStream.factory,"\ndebugSinkStream.factory( [options] )\n    Returns a function for creating writable streams for debugging stream\n    pipelines.\n\n    Parameters\n    ----------\n    options: Object (optional)\n        Options.\n\n    options.objectMode: boolean (optional)\n        Specifies whether a stream should operate in \"objectMode\". Default:\n        false.\n\n    options.highWaterMark: integer (optional)\n        Specifies the maximum number of bytes to store in an internal buffer\n        before ceasing to push downstream.\n\n    options.decodeStrings: boolean (optional)\n        Specifies whether to encode strings as `Buffer` objects before writing\n        data to a returned stream. Default: true.\n\n    options.defaultEncoding: string (optional)\n        Default encoding when not explicitly specified when writing data.\n        Default: 'utf8'.\n\n    Returns\n    -------\n    createStream( name[, clbk] ): Function\n        Function for creating writable streams.\n\n    Examples\n    --------\n    > var opts = { 'objectMode': true, 'highWaterMark': 64 };\n    > var createStream = debugSinkStream.factory( opts );"
 debugSinkStream.objectMode,"\ndebugSinkStream.objectMode( [options,] [clbk] )\n    Returns an \"objectMode\" writable stream for debugging stream pipelines.\n\n    Parameters\n    ----------\n    options: Object (optional)\n        Options.\n\n    options.name: string (optional)\n        Debug namespace.\n\n    options.highWaterMark: integer (optional)\n        Specifies the maximum number of objects to store in an internal buffer\n        before ceasing to push downstream.\n\n    options.decodeStrings: boolean (optional)\n        Specifies whether to encode strings as `Buffer` objects before writing\n        data to a returned stream. Default: true.\n\n    options.defaultEncoding: string (optional)\n        Default encoding when not explicitly specified when writing data.\n        Default: 'utf8'.\n\n    clbk: Function (optional)\n        Callback to invoke upon receiving data.\n\n    Returns\n    -------\n    stream: WritableStream\n        Writable stream operating in \"objectMode\".\n\n    Examples\n    --------\n    > var s = debugSinkStream.objectMode( { 'name': 'foo' } );\n    > s.write( { 'value': 'a' } );\n    > s.write( { 'value': 'b' } );\n    > s.write( { 'value': 'c' } );\n    > s.end();\n\n    See Also\n    --------\n    debugStream, inspectSinkStream"