Skip to content

Commit 8777ff6

Browse files
authored
docs: update REPL namespace documentation
PR-URL: #12327 Reviewed-by: Athan Reines <kgryte@gmail.com>
1 parent 80ccc9e commit 8777ff6

8 files changed

Lines changed: 8 additions & 8 deletions

File tree

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3718,7 +3718,7 @@ isObjectLike,"\nisObjectLike( value )\n Tests if a value is object-like.\n\n
37183718
isOdd,"\nisOdd( value )\n Tests if a value is an odd number.\n\n Parameters\n ----------\n value: any\n Value to test.\n\n Returns\n -------\n bool: boolean\n Boolean indicating whether value is an odd number.\n\n Examples\n --------\n > var bool = isOdd( 5.0 )\n true\n > bool = isOdd( new Number( 5.0 ) )\n true\n > bool = isOdd( 4.0 )\n false\n > bool = isOdd( new Number( 4.0 ) )\n false\n > bool = isOdd( -3.14 )\n false\n > bool = isOdd( null )\n false\n\nisOdd.isPrimitive( value )\n Tests if a value is a number primitive that is an odd number.\n\n Parameters\n ----------\n value: any\n Value to test.\n\n Returns\n -------\n bool: boolean\n Boolean indicating whether value is a number primitive that is an odd\n number.\n\n Examples\n --------\n > var bool = isOdd.isPrimitive( -5.0 )\n true\n > bool = isOdd.isPrimitive( new Number( -5.0 ) )\n false\n\n\nisOdd.isObject( value )\n Tests if a value is a number object that has an odd number value.\n\n Parameters\n ----------\n value: any\n Value to test.\n\n Returns\n -------\n bool: boolean\n Boolean indicating whether value is a number object that has an odd\n number value.\n\n Examples\n --------\n > var bool = isOdd.isObject( 5.0 )\n false\n > bool = isOdd.isObject( new Number( 5.0 ) )\n true\n\n See Also\n --------\n isEven\n"
37193719
isOdd.isPrimitive,"\nisOdd.isPrimitive( value )\n Tests if a value is a number primitive that is an odd number.\n\n Parameters\n ----------\n value: any\n Value to test.\n\n Returns\n -------\n bool: boolean\n Boolean indicating whether value is a number primitive that is an odd\n number.\n\n Examples\n --------\n > var bool = isOdd.isPrimitive( -5.0 )\n true\n > bool = isOdd.isPrimitive( new Number( -5.0 ) )\n false"
37203720
isOdd.isObject,"\nisOdd.isObject( value )\n Tests if a value is a number object that has an odd number value.\n\n Parameters\n ----------\n value: any\n Value to test.\n\n Returns\n -------\n bool: boolean\n Boolean indicating whether value is a number object that has an odd\n number value.\n\n Examples\n --------\n > var bool = isOdd.isObject( 5.0 )\n false\n > bool = isOdd.isObject( new Number( 5.0 ) )\n true\n\n See Also\n --------\n isEven"
3721-
isoWeeksInYear,"\nisoWeeksInYear( [year] )\n Returns the number of ISO weeks in a year according to the Gregorian\n calendar.\n\n By default, the function returns the number of ISO weeks in the current year\n (according to local time). To determine the number of ISO weeks for a\n particular year, provide either a year or a `Date` object.\n\n Parameters\n ----------\n year: integer (optional)\n Year.\n\n Returns\n -------\n out: integer\n Number of ISO weeks in a year.\n\n Examples\n --------\n > var num = isoWeeksInYear()\n <number>\n > num = isoWeeksInYear( 2015 )\n 53\n > num = isoWeeksInYear( 2017 )\n 52\n\n"
3721+
isoWeeksInYear,"\nisoWeeksInYear( [value] )\n Returns the number of ISO weeks in a year according to the Gregorian\n calendar.\n\n By default, the function returns the number of ISO weeks in the current year\n (according to local time). To determine the number of ISO weeks for a\n particular 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 ISO weeks in a year.\n\n Examples\n --------\n > var num = isoWeeksInYear()\n <number>\n > num = isoWeeksInYear( 2015 )\n 53\n > num = isoWeeksInYear( 2017 )\n 52\n\n"
37223722
isPascalcase,"\nisPascalcase( value )\n Tests if a value is a string in Pascal case.\n\n Parameters\n ----------\n value: any\n Value to test.\n\n Returns\n -------\n bool: boolean\n Boolean indicating whether a value is a string in Pascal case.\n\n Examples\n --------\n > var bool = isPascalcase( 'HelloWorld' )\n true\n > bool = isPascalcase( 'hello-world' )\n false\n\n See Also\n --------\n isString"
37233723
isPersymmetricMatrix,"\nisPersymmetricMatrix( value )\n Tests if a value is a square matrix which is symmetric about its\n antidiagonal.\n\n Parameters\n ----------\n value: any\n Value to test.\n\n Returns\n -------\n bool: boolean\n Boolean indicating whether a value is a persymmetric matrix.\n\n Examples\n --------\n > var buf = [ 1, 2, 3, 1 ];\n > var sh = [ 2, 2 ];\n > var st = [ 2, 1 ];\n > var M = ndarray( 'generic', buf, sh, st, 0, 'row-major' );\n > var bool = isPersymmetricMatrix( M )\n true\n > bool = isPersymmetricMatrix( [ 1, 2, 3, 4 ] )\n false\n > bool = isPersymmetricMatrix( 3.14 )\n false\n > bool = isPersymmetricMatrix( {} )\n false\n\n See Also\n --------\n isMatrixLike, isSquareMatrix, isSymmetricMatrix\n"
37243724
isPlainObject,"\nisPlainObject( value )\n Tests if a value is a plain object.\n\n Parameters\n ----------\n value: any\n Value to test.\n\n Returns\n -------\n bool: boolean\n Boolean indicating whether value is a plain object.\n\n Examples\n --------\n > var bool = isPlainObject( {} )\n true\n > bool = isPlainObject( null )\n false\n\n See Also\n --------\n isObject\n"

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

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

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3718,7 +3718,7 @@ isObjectLike,"\nisObjectLike( value:any )\n Tests if a value is object-like.\
37183718
isOdd,"\nisOdd( value:any )\n Tests if a value is an odd number.\n"
37193719
isOdd.isPrimitive,"\nisOdd.isPrimitive( value:any )\n Tests if a value is a number primitive that is an odd number.\n"
37203720
isOdd.isObject,"\nisOdd.isObject( value:any )\n Tests if a value is a number object that has an odd number value.\n"
3721-
isoWeeksInYear,"\nisoWeeksInYear( [year:integer] )\n Returns the number of ISO weeks in a year according to the Gregorian\n calendar.\n"
3721+
isoWeeksInYear,"\nisoWeeksInYear( [value:integer|Date] )\n Returns the number of ISO weeks in a year according to the Gregorian\n calendar.\n"
37223722
isPascalcase,"\nisPascalcase( value:any )\n Tests if a value is a string in Pascal case.\n"
37233723
isPersymmetricMatrix,"\nisPersymmetricMatrix( value:any )\n Tests if a value is a square matrix which is symmetric about its\n antidiagonal.\n"
37243724
isPlainObject,"\nisPlainObject( value:any )\n Tests if a value is a plain object.\n"

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

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

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3797,7 +3797,7 @@ isObjectLike,"isObjectLike( value )"
37973797
isOdd,"isOdd( value )"
37983798
isOdd.isPrimitive,"isOdd.isPrimitive( value )"
37993799
isOdd.isObject,"isOdd.isObject( value )"
3800-
isoWeeksInYear,"isoWeeksInYear( [year] )"
3800+
isoWeeksInYear,"isoWeeksInYear( [value] )"
38013801
isPascalcase,"isPascalcase( value )"
38023802
isPersymmetricMatrix,"isPersymmetricMatrix( value )"
38033803
isPlainObject,"isPlainObject( value )"

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

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

lib/node_modules/@stdlib/repl/typed-signature/data/data.csv

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3797,7 +3797,7 @@ isObjectLike,"isObjectLike( value:any )"
37973797
isOdd,"isOdd( value:any )"
37983798
isOdd.isPrimitive,"isOdd.isPrimitive( value:any )"
37993799
isOdd.isObject,"isOdd.isObject( value:any )"
3800-
isoWeeksInYear,"isoWeeksInYear( [year:integer] )"
3800+
isoWeeksInYear,"isoWeeksInYear( [value:integer|Date] )"
38013801
isPascalcase,"isPascalcase( value:any )"
38023802
isPersymmetricMatrix,"isPersymmetricMatrix( value:any )"
38033803
isPlainObject,"isPlainObject( value:any )"

lib/node_modules/@stdlib/repl/typed-signature/data/data.json

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

0 commit comments

Comments
 (0)