Skip to content

Commit f3d2c00

Browse files
authored
docs: update REPL namespace documentation
PR-URL: #9316 Reviewed-by: Athan Reines <[email protected]>
1 parent 29fc92b commit f3d2c00

File tree

2 files changed

+3
-3
lines changed

2 files changed

+3
-3
lines changed

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

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2625,7 +2625,7 @@ buffer2json,"\nbuffer2json( buffer )\n Returns a JSON representation of a buf
26252625
BYTE_ORDER,"\nBYTE_ORDER\n Platform byte order.\n\n Possible values:\n\n - 'little-endian'\n - 'big-endian'\n - 'mixed-endian'\n - 'unknown'\n\n Examples\n --------\n > BYTE_ORDER\n <string>\n\n See Also\n --------\n IS_BIG_ENDIAN, IS_LITTLE_ENDIAN\n"
26262626
camelcase,"\ncamelcase( str )\n Converts a string to camel case.\n\n Parameters\n ----------\n str: string\n Input string.\n\n Returns\n -------\n out: string\n Camel-cased string.\n\n Examples\n --------\n > var out = camelcase( 'Hello World!' )\n 'helloWorld'\n > out = camelcase( 'beep boop' )\n 'beepBoop'\n\n See Also\n --------\n constantcase, kebabcase, pascalcase, snakecase"
26272627
capitalize,"\ncapitalize( str )\n Capitalizes the first character in a string.\n\n Parameters\n ----------\n str: string\n Input string.\n\n Returns\n -------\n out: string\n Capitalized string.\n\n Examples\n --------\n > var out = capitalize( 'beep' )\n 'Beep'\n > out = capitalize( 'Boop' )\n 'Boop'\n\n See Also\n --------\n uncapitalize, uppercase\n"
2628-
capitalizeKeys,"\ncapitalizeKeys( obj )\n Converts the first letter of each object key to uppercase.\n\n The function only transforms own properties. Hence, the function does not\n transform inherited properties.\n\n The function shallow copies key values.\n\n Parameters\n ----------\n obj: Object\n Source object.\n\n Returns\n -------\n out: Object\n New object.\n\n Examples\n --------\n > var obj = { 'aa': 1, 'bb': 2 };\n > var out = capitalizeKeys( obj )\n { 'Aa': 1, 'Bb': 2 }\n\n See Also\n --------\n uppercaseKeys\n"
2628+
capitalizeKeys,"\ncapitalizeKeys( obj )\n Converts the first letter of each object key to uppercase.\n\n The function only transforms own properties. Hence, the function does not\n transform inherited properties.\n\n The function shallow copies key values.\n\n Parameters\n ----------\n obj: Object\n Source object.\n\n Returns\n -------\n out: Object\n New object.\n\n Examples\n --------\n > var obj = { 'aa': 1, 'bb': 2 };\n > var out = capitalizeKeys( obj )\n { 'Aa': 1, 'Bb': 2 }\n\n See Also\n --------\n uncapitalizeKeys, uppercaseKeys\n"
26292629
CATALAN,"\nCATALAN\n Catalan's constant.\n\n Examples\n --------\n > CATALAN\n 0.915965594177219\n\n"
26302630
CBRT_EPS,"\nCBRT_EPS\n Cube root of double-precision floating-point epsilon.\n\n Examples\n --------\n > CBRT_EPS\n 0.0000060554544523933395\n\n See Also\n --------\n EPS, SQRT_EPS\n"
26312631
CDC_NCHS_US_BIRTHS_1969_1988,"\nCDC_NCHS_US_BIRTHS_1969_1988()\n Returns US birth data from 1969 to 1988, as provided by the Center for\n Disease Control and Prevention's National Center for Health Statistics.\n\n Returns\n -------\n out: Array<Object>\n Birth data.\n\n Examples\n --------\n > var data = CDC_NCHS_US_BIRTHS_1969_1988()\n [ {...}, ... ]\n\n See Also\n --------\n CDC_NCHS_US_BIRTHS_1994_2003, SSA_US_BIRTHS_2000_2014\n"
@@ -4077,7 +4077,7 @@ LOG2E,"\nLOG2E\n Base 2 logarithm of Euler's number.\n\n Examples\n ---
40774077
LOG10E,"\nLOG10E\n Base 10 logarithm of Euler's number.\n\n Examples\n --------\n > LOG10E\n 0.4342944819032518\n\n See Also\n --------\n E, LOG2E\n"
40784078
logspace,"\nlogspace( a, b[, length] )\n Generates a logarithmically spaced numeric array between `10^a` and `10^b`.\n\n If a `length` is not provided, the default output array length is `10`.\n\n The output array includes the values `10^a` and `10^b`.\n\n Parameters\n ----------\n a: number\n Exponent of start value.\n\n b: number\n Exponent of end value.\n\n length: integer (optional)\n Length of output array. Default: `10`.\n\n Returns\n -------\n arr: Array\n Logarithmically spaced numeric array.\n\n Examples\n --------\n > var arr = logspace( 0, 2, 6 )\n [ 1, ~2.5, ~6.31, ~15.85, ~39.81, 100 ]\n\n See Also\n --------\n incrspace, linspace\n"
40794079
lowercase,"\nlowercase( str )\n Converts a string to lowercase.\n\n Parameters\n ----------\n str: string\n Input string.\n\n Returns\n -------\n out: string\n Lowercase string.\n\n Examples\n --------\n > var out = lowercase( 'bEEp' )\n 'beep'\n\n See Also\n --------\n uncapitalize, uppercase\n"
4080-
lowercaseKeys,"\nlowercaseKeys( obj )\n Converts each object key to lowercase.\n\n The function only transforms own properties. Hence, the function does not\n transform inherited properties.\n\n The function shallow copies key values.\n\n Parameters\n ----------\n obj: Object\n Source object.\n\n Returns\n -------\n out: Object\n New object.\n\n Examples\n --------\n > var obj = { 'A': 1, 'B': 2 };\n > var out = lowercaseKeys( obj )\n { 'a': 1, 'b': 2 }\n\n See Also\n --------\n uppercaseKeys\n"
4080+
lowercaseKeys,"\nlowercaseKeys( obj )\n Converts each object key to lowercase.\n\n The function only transforms own properties. Hence, the function does not\n transform inherited properties.\n\n The function shallow copies key values.\n\n Parameters\n ----------\n obj: Object\n Source object.\n\n Returns\n -------\n out: Object\n New object.\n\n Examples\n --------\n > var obj = { 'A': 1, 'B': 2 };\n > var out = lowercaseKeys( obj )\n { 'a': 1, 'b': 2 }\n\n See Also\n --------\n uncapitalizeKeys, uppercaseKeys\n"
40814081
lowess,"\nlowess( x, y[, options] )\n Locally-weighted polynomial regression via the LOWESS algorithm.\n\n Parameters\n ----------\n x: Array<number>\n x-axis values (abscissa values).\n\n y: Array<number>\n Corresponding y-axis values (ordinate values).\n\n options: Object (optional)\n Function options.\n\n options.f: number (optional)\n Positive number specifying the smoothing span, i.e., the proportion of\n points which influence smoothing at each value. Larger values\n correspond to more smoothing. Default: `2/3`.\n\n options.nsteps: number (optional)\n Number of iterations in the robust fit (fewer iterations translates to\n faster function execution). If set to zero, the nonrobust fit is\n returned. Default: `3`.\n\n options.delta: number (optional)\n Nonnegative number which may be used to reduce the number of\n computations. Default: 1/100th of the range of `x`.\n\n options.sorted: boolean (optional)\n Boolean indicating if the input array `x` is sorted. Default: `false`.\n\n Returns\n -------\n out: Object\n Object with ordered x-values and fitted values.\n\n Examples\n --------\n > var x = new Float64Array( 100 );\n > var y = new Float64Array( x.length );\n > for ( var i = 0; i < x.length; i++ ) {\n ... x[ i ] = i;\n ... y[ i ] = ( 0.5*i ) + ( 10.0*base.random.randn() );\n ... }\n > var out = lowess( x, y );\n > var yhat = out.y;\n\n > var h = Plot( [ x, x ], [ y, yhat ] );\n > h.lineStyle = [ 'none', '-' ];\n > h.symbols = [ 'closed-circle', 'none' ];\n\n > h.view( 'window' );\n\n"
40824082
lpad,"\nlpad( str, len[, pad] )\n Left pads a string such that the padded string has a length of at least\n `len`.\n\n An output string is not guaranteed to have a length of exactly `len`, but to\n have a length of at least `len`. To generate a padded string having a length\n equal to `len`, post-process a padded string by trimming off excess\n characters.\n\n Parameters\n ----------\n str: string\n Input string.\n\n len: integer\n Minimum string length.\n\n pad: string (optional)\n String used to pad. Default: ' '.\n\n Returns\n -------\n out: string\n Padded string.\n\n Examples\n --------\n > var out = lpad( 'a', 5 )\n ' a'\n > out = lpad( 'beep', 10, 'b' )\n 'bbbbbbbeep'\n > out = lpad( 'boop', 12, 'beep' )\n 'beepbeepboop'\n\n See Also\n --------\n pad, rpad\n"
40834083
ltrim,"\nltrim( str )\n Trims whitespace from the beginning 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 = ltrim( ' \r\n\t Beep \t\t\n ' )\n 'Beep \t\t\n '\n\n See Also\n --------\n trim, rtrim\n"

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

Lines changed: 1 addition & 1 deletion
Large diffs are not rendered by default.

0 commit comments

Comments
 (0)