Skip to content

Commit

Permalink
docs: update REPL namespace documentation
Browse files Browse the repository at this point in the history
PR-URL: #2682
Reviewed-by: Athan Reines <[email protected]>
Reviewed-by: Philipp Burckhardt <[email protected]>
Signed-off-by: stdlib-bot <[email protected]>
Co-authored-by: Philipp Burckhardt <[email protected]>
  • Loading branch information
stdlib-bot and Planeshifter authored Jul 27, 2024
1 parent 1655420 commit 70eb789
Show file tree
Hide file tree
Showing 11 changed files with 11 additions and 11 deletions.
2 changes: 1 addition & 1 deletion lib/node_modules/@stdlib/repl/code-blocks/data/data.csv
Original file line number Diff line number Diff line change
Expand Up @@ -2536,7 +2536,7 @@ base.truncateMiddle,"var str = 'beep boop';\nvar out = base.truncateMiddle( str,
base.truncb,"var y = base.truncb( 3.14159, -4, 10 )\ny = base.truncb( 3.14159, 0, 2 )\ny = base.truncb( 5.0, 1, 2 )\n"
base.truncf,"var y = base.truncf( 3.14 )\ny = base.truncf( -4.2 )\ny = base.truncf( -4.6 )\ny = base.truncf( 9.5 )\ny = base.truncf( -0.0 )\n"
base.truncn,"var y = base.truncn( 3.14159, -4 )\ny = base.truncn( 3.14159, 0 )\ny = base.truncn( 12368.0, 3 )\n"
base.truncsd,"var y = base.truncsd( 3.14159, 5 )\ny = base.truncsd( 3.14159, 1 )\ny = base.truncsd( 12368.0, 2 )\ny = base.truncsd( 0.0313, 2, 2 )\n"
base.truncsd,"var y = base.truncsd( 3.14159, 5, 10 )\ny = base.truncsd( 3.14159, 1, 10 )\ny = base.truncsd( 12368.0, 2, 10 )\ny = base.truncsd( 0.0313, 2, 2 )\n"
base.uint32ToInt32,"var y = base.uint32ToInt32( base.float64ToUint32( 4294967295 ) )\ny = base.uint32ToInt32( base.float64ToUint32( 3 ) )\n"
base.umul,"var v = base.umul( 10>>>0, 4>>>0 )\n"
base.umuldw,"var v = base.umuldw( 1, 10 )\n"
Expand Down
2 changes: 1 addition & 1 deletion lib/node_modules/@stdlib/repl/code-blocks/data/data.json

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion lib/node_modules/@stdlib/repl/data/contributor.json
Original file line number Diff line number Diff line change
@@ -1 +1 @@
["Adarsh Palaskar","Aditya Sapra","AgPriyanshu18","Aleksandr","Ali Salesi","Aman Bhansali","Amit Jimiwal","Anudeep Sanapala","Athan Reines","Ayaka","Brendan Graetz","Bruno Fenzl","Bryan Elee","Chinmay Joshi","Christopher Dambamuromo","Dan Rose","Daniel Killenberger","Daniel Yu","Dominik Moritz","Dorrin Sotoudeh","EuniceSim142","Frank Kovacs","Golden Kumar","Gunj Joshi","Harshita Kalani","Hridyanshu","Jaimin Godhani","James Gelok","Jaysukh Makvana","Jithin KS","Joel Mathew Koshy","Joey Reed","Jordan Gallivan","Joris Labie","Justin Dennison","Karthik Prakash","Khaldon","Krishnendu Das","Lovelin","Manik Sharma","Marcus Fantham","Matt Cochrane","Mihir Pandit","Milan Raj","Momtchil Momtchev","Muhammad Haris","Naresh Jagadeesan","NightKnight","Nithin Katta","Ognjen Jevremović","Oneday12323","Philipp Burckhardt","Prajwal Kulkarni","Pranav Goswami","Praneki","Pratik","Priyansh","Pushpendra Chandravanshi","Raunak Kumar Gupta","Rejoan Sardar","Ricky Reusser","Ridam Garg","Robert Gislason","Roman Stetsyk","Rutam","Ryan Seal","Sai Srikar Dumpeti","Seyyed Parsa Neshaei","Shashank Shekhar Singh","Shivam","Shraddheya Shendre","Shubh Mehta","Shubham Mishra","Sivam Das","Snehil Shah","Soumajit Chatterjee","Spandan Barve","Stephannie Jiménez Gacha","Suraj kumar","Tirtadwipa Manunggal","Tudor Pagu","Utkarsh","Utkarsh Raj","Varad Gupta","Xiaochuan Ye","Yernar Yergaziyev","naveen","nishant-s7","orimiles5","rainn","rei2hu"]
["Adarsh Palaskar","Aditya Sapra","AgPriyanshu18","Aleksandr","Ali Salesi","Aman Bhansali","Amit Jimiwal","Anudeep Sanapala","Athan Reines","Ayaka","Brendan Graetz","Bruno Fenzl","Bryan Elee","Chinmay Joshi","Christopher Dambamuromo","Dan Rose","Daniel Killenberger","Daniel Yu","Dominik Moritz","Dorrin Sotoudeh","EuniceSim142","Frank Kovacs","Golden Kumar","Gunj Joshi","Harshita Kalani","Hridyanshu","Jaimin Godhani","James Gelok","Jaysukh Makvana","Jithin KS","Joel Mathew Koshy","Joey Reed","Jordan Gallivan","Joris Labie","Justin Dennison","Karthik Prakash","Khaldon","Krishnendu Das","Lovelin","Manik Sharma","Marcus Fantham","Matt Cochrane","Mihir Pandit","Milan Raj","Momtchil Momtchev","Muhammad Haris","Naresh Jagadeesan","NightKnight","Nithin Katta","Nourhan Hasan","Ognjen Jevremović","Oneday12323","Philipp Burckhardt","Prajwal Kulkarni","Pranav Goswami","Praneki","Pratik","Priyansh","Pushpendra Chandravanshi","Raunak Kumar Gupta","Rejoan Sardar","Ricky Reusser","Ridam Garg","Robert Gislason","Roman Stetsyk","Rutam","Ryan Seal","Sai Srikar Dumpeti","Seyyed Parsa Neshaei","Shashank Shekhar Singh","Shivam","Shraddheya Shendre","Shubh Mehta","Shubham Mishra","Sivam Das","Snehil Shah","Soumajit Chatterjee","Spandan Barve","Stephannie Jiménez Gacha","Suraj kumar","Tirtadwipa Manunggal","Tudor Pagu","Utkarsh","Utkarsh Raj","Varad Gupta","Xiaochuan Ye","Yernar Yergaziyev","naveen","nishant-s7","orimiles5","rainn","rei2hu"]
2 changes: 1 addition & 1 deletion lib/node_modules/@stdlib/repl/help/data/data.csv
Original file line number Diff line number Diff line change
Expand Up @@ -2536,7 +2536,7 @@ base.truncateMiddle,"\nbase.truncateMiddle( str, len, seq )\n Truncates the m
base.truncb,"\nbase.truncb( x, n, b )\n Rounds a numeric value to the nearest multiple of `b^n` toward zero.\n\n Due to floating-point rounding error, rounding may not be exact.\n\n Parameters\n ----------\n x: number\n Input value.\n\n n: integer\n Integer power.\n\n b: integer\n Base.\n\n Returns\n -------\n y: number\n Rounded value.\n\n Examples\n --------\n // Round to 4 decimal places:\n > var y = base.truncb( 3.14159, -4, 10 )\n 3.1415\n\n // If `n = 0` or `b = 1`, standard round behavior:\n > y = base.truncb( 3.14159, 0, 2 )\n 3.0\n\n // Round to nearest multiple of two toward zero:\n > y = base.truncb( 5.0, 1, 2 )\n 4.0\n\n See Also\n --------\n base.ceilb, base.floorb, base.roundb, base.trunc, base.truncn\n"
base.truncf,"\nbase.truncf( x )\n Rounds a single-precision floating-point number toward zero.\n\n Parameters\n ----------\n x: number\n Input value.\n\n Returns\n -------\n y: number\n Rounded value.\n\n Examples\n --------\n > var y = base.truncf( 3.14 )\n 3.0\n > y = base.truncf( -4.2 )\n -4.0\n > y = base.truncf( -4.6 )\n -4.0\n > y = base.truncf( 9.5 )\n 9.0\n > y = base.truncf( -0.0 )\n -0.0\n\n See Also\n --------\n base.ceilf, base.floorf, base.trunc\n"
base.truncn,"\nbase.truncn( x, n )\n Rounds a numeric value to the nearest multiple of `10^n` toward zero.\n\n When operating on floating-point numbers in bases other than `2`, rounding\n to specified digits can be inexact.\n\n Parameters\n ----------\n x: number\n Input value.\n\n n: integer\n Integer power of 10.\n\n Returns\n -------\n y: number\n Rounded value.\n\n Examples\n --------\n // Round to 4 decimal places:\n > var y = base.truncn( 3.14159, -4 )\n 3.1415\n\n // If `n = 0`, standard round behavior:\n > y = base.truncn( 3.14159, 0 )\n 3.0\n\n // Round to nearest thousand:\n > y = base.truncn( 12368.0, 3 )\n 12000.0\n\n\n See Also\n --------\n base.ceiln, base.floorn, base.roundn, base.trunc, base.truncb\n"
base.truncsd,"\nbase.truncsd( x, n[, b] )\n Rounds a numeric value to the nearest number toward zero with `n`\n significant figures.\n\n Parameters\n ----------\n x: number\n Input value.\n\n n: integer\n Number of significant figures. Must be greater than 0.\n\n b: integer (optional)\n Base. Must be greater than 0. Default: 10.\n\n Returns\n -------\n y: number\n Rounded value.\n\n Examples\n --------\n > var y = base.truncsd( 3.14159, 5 )\n 3.1415\n > y = base.truncsd( 3.14159, 1 )\n 3.0\n > y = base.truncsd( 12368.0, 2 )\n 12000.0\n > y = base.truncsd( 0.0313, 2, 2 )\n 0.03125\n\n See Also\n --------\n base.ceilsd, base.floorsd, base.roundsd, base.trunc\n"
base.truncsd,"\nbase.truncsd( x, n, b )\n Rounds a numeric value to the nearest number toward zero with `n`\n significant figures.\n\n Parameters\n ----------\n x: number\n Input value.\n\n n: integer\n Number of significant figures. Must be greater than 0.\n\n b: integer\n Base. Must be greater than 0.\n\n Returns\n -------\n y: number\n Rounded value.\n\n Examples\n --------\n > var y = base.truncsd( 3.14159, 5, 10 )\n 3.1415\n > y = base.truncsd( 3.14159, 1, 10 )\n 3.0\n > y = base.truncsd( 12368.0, 2, 10 )\n 12000.0\n > y = base.truncsd( 0.0313, 2, 2 )\n 0.03125\n\n See Also\n --------\n base.ceilsd, base.floorsd, base.roundsd, base.trunc\n"
base.uint32ToInt32,"\nbase.uint32ToInt32( x )\n Converts an unsigned 32-bit integer to a signed 32-bit integer.\n\n Parameters\n ----------\n x: integer\n Unsigned 32-bit integer.\n\n Returns\n -------\n out: integer\n Signed 32-bit integer.\n\n Examples\n --------\n > var y = base.uint32ToInt32( base.float64ToUint32( 4294967295 ) )\n -1\n > y = base.uint32ToInt32( base.float64ToUint32( 3 ) )\n 3\n\n"
base.umul,"\nbase.umul( a, b )\n Performs C-like multiplication of two unsigned 32-bit integers.\n\n Parameters\n ----------\n a: integer\n Unsigned 32-bit integer.\n\n b: integer\n Unsigned 32-bit integer.\n\n Returns\n -------\n out: integer\n Product.\n\n Examples\n --------\n > var v = base.umul( 10>>>0, 4>>>0 )\n 40\n\n See Also\n --------\n base.imul\n"
base.umuldw,"\nbase.umuldw( a, b )\n Multiplies two unsigned 32-bit integers and returns an array of two unsigned\n 32-bit integers which represents the unsigned 64-bit integer product.\n\n When computing the product of 32-bit integer values in double-precision\n floating-point format (the default JavaScript numeric data type), computing\n the double word product is necessary in order to avoid exceeding the maximum\n safe double-precision floating-point integer value.\n\n Parameters\n ----------\n a: integer\n Unsigned 32-bit integer.\n\n b: integer\n Unsigned 32-bit integer.\n\n Returns\n -------\n out: Array<number>\n Double word product (in big endian order; i.e., the first element\n corresponds to the most significant bits and the second element to the\n least significant bits).\n\n Examples\n --------\n > var v = base.umuldw( 1, 10 )\n [ 0, 10 ]\n\n\nbase.umuldw.assign( a, b, out, stride, offset )\n Multiplies two unsigned 32-bit integers and assigns results representing\n the unsigned 64-bit integer product to a provided output array.\n\n When computing the product of 32-bit integer values in double-precision\n floating-point format (the default JavaScript numeric data type), computing\n the double word product is necessary in order to avoid exceeding the maximum\n safe double-precision floating-point integer value.\n\n Parameters\n ----------\n a: integer\n Unsigned 32-bit integer.\n\n b: integer\n Unsigned 32-bit integer.\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 Double word product (in big endian order; i.e., the first element\n corresponds to the most significant bits and the second element to the\n least significant bits).\n\n Examples\n --------\n > var out = [ 0, 0 ];\n > var v = base.umuldw.assign( 1, 10, out, 1, 0 )\n [ 0, 10 ]\n > var bool = ( v === out )\n true\n\n See Also\n --------\n base.imuldw, base.umul\n"
Expand Down
2 changes: 1 addition & 1 deletion lib/node_modules/@stdlib/repl/help/data/data.json

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion lib/node_modules/@stdlib/repl/info/data/data.csv
Original file line number Diff line number Diff line change
Expand Up @@ -2536,7 +2536,7 @@ base.truncateMiddle,"\nbase.truncateMiddle( str:string, len:integer, seq:string
base.truncb,"\nbase.truncb( x:number, n:integer, b:integer )\n Rounds a numeric value to the nearest multiple of `b^n` toward zero.\n"
base.truncf,"\nbase.truncf( x:number )\n Rounds a single-precision floating-point number toward zero.\n"
base.truncn,"\nbase.truncn( x:number, n:integer )\n Rounds a numeric value to the nearest multiple of `10^n` toward zero.\n"
base.truncsd,"\nbase.truncsd( x:number, n:integer[, b:integer] )\n Rounds a numeric value to the nearest number toward zero with `n`\n significant figures.\n"
base.truncsd,"\nbase.truncsd( x:number, n:integer, b:integer )\n Rounds a numeric value to the nearest number toward zero with `n`\n significant figures.\n"
base.uint32ToInt32,"\nbase.uint32ToInt32( x:integer )\n Converts an unsigned 32-bit integer to a signed 32-bit integer.\n"
base.umul,"\nbase.umul( a:integer, b:integer )\n Performs C-like multiplication of two unsigned 32-bit integers.\n"
base.umuldw,"\nbase.umuldw( a:integer, b:integer )\n Multiplies two unsigned 32-bit integers and returns an array of two unsigned\n 32-bit integers which represents the unsigned 64-bit integer product.\n"
Expand Down
2 changes: 1 addition & 1 deletion lib/node_modules/@stdlib/repl/info/data/data.json

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion lib/node_modules/@stdlib/repl/signature/data/data.csv
Original file line number Diff line number Diff line change
Expand Up @@ -2537,7 +2537,7 @@ base.truncateMiddle,"base.truncateMiddle( str, len, seq )"
base.truncb,"base.truncb( x, n, b )"
base.truncf,"base.truncf( x )"
base.truncn,"base.truncn( x, n )"
base.truncsd,"base.truncsd( x, n[, b] )"
base.truncsd,"base.truncsd( x, n, b )"
base.uint32ToInt32,"base.uint32ToInt32( x )"
base.umul,"base.umul( a, b )"
base.umuldw,"base.umuldw( a, b )"
Expand Down
2 changes: 1 addition & 1 deletion lib/node_modules/@stdlib/repl/signature/data/data.json

Large diffs are not rendered by default.

Original file line number Diff line number Diff line change
Expand Up @@ -2537,7 +2537,7 @@ base.truncateMiddle,"base.truncateMiddle( str:string, len:integer, seq:string )"
base.truncb,"base.truncb( x:number, n:integer, b:integer )"
base.truncf,"base.truncf( x:number )"
base.truncn,"base.truncn( x:number, n:integer )"
base.truncsd,"base.truncsd( x:number, n:integer[, b:integer] )"
base.truncsd,"base.truncsd( x:number, n:integer, b:integer )"
base.uint32ToInt32,"base.uint32ToInt32( x:integer )"
base.umul,"base.umul( a:integer, b:integer )"
base.umuldw,"base.umuldw( a:integer, b:integer )"
Expand Down

Large diffs are not rendered by default.

1 comment on commit 70eb789

@stdlib-bot
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Coverage Report

Package Statements Branches Functions Lines
repl/code-blocks $\color{green}95/95$
$\color{green}+100.00\%$
$\color{green}7/7$
$\color{green}+100.00\%$
$\color{green}1/1$
$\color{green}+100.00\%$
$\color{green}95/95$
$\color{green}+100.00\%$
repl $\color{red}10405/12996$
$\color{green}+80.06\%$
$\color{red}632/863$
$\color{green}+73.23\%$
$\color{red}146/232$
$\color{green}+62.93\%$
$\color{red}10405/12996$
$\color{green}+80.06\%$
repl/help $\color{green}95/95$
$\color{green}+100.00\%$
$\color{green}7/7$
$\color{green}+100.00\%$
$\color{green}1/1$
$\color{green}+100.00\%$
$\color{green}95/95$
$\color{green}+100.00\%$
repl/info $\color{green}95/95$
$\color{green}+100.00\%$
$\color{green}7/7$
$\color{green}+100.00\%$
$\color{green}1/1$
$\color{green}+100.00\%$
$\color{green}95/95$
$\color{green}+100.00\%$
repl/signature $\color{green}99/99$
$\color{green}+100.00\%$
$\color{green}10/10$
$\color{green}+100.00\%$
$\color{green}1/1$
$\color{green}+100.00\%$
$\color{green}99/99$
$\color{green}+100.00\%$
repl/typed-signature $\color{green}99/99$
$\color{green}+100.00\%$
$\color{green}10/10$
$\color{green}+100.00\%$
$\color{green}1/1$
$\color{green}+100.00\%$
$\color{green}99/99$
$\color{green}+100.00\%$

The above coverage report was generated for the changes in this push.

Please sign in to comment.