Skip to content

docs: update REPL namespace documentation #7161

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Jun 2, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
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 @@
["Aadish Jain","Aarya Balwadkar","Aayush Khanna","Abdelrahman Samir","Abdul Kaium","Abhay Punia","Abhijit Raut","Abhishek Jain","Adarsh Palaskar","Aditya Sapra","Ahmed Atwa","Ahmed Kashkoush","Ahmed Khaled","Aksshay Balasubramanian","Aleksandr","Ali Salesi","AlyAbdelmoneim","Aman Bhansali","AmanBhadkariya","Amit Jimiwal","Anshu Kumar","Anshu Kumar","Anudeep Sanapala","Athan Reines","Ayaka","Bhavishy Agrawal","Brendan Graetz","Bruno Fenzl","Bryan Elee","Chinmay Joshi","Christopher Dambamuromo","Dan Rose","Daniel Killenberger","Daniel Yu","Debashis Maharana","Deep Trivedi","Desh Deepak Kant","Dev Goel","Dhanyabad behera","Dhruv Arvind Singh","Dhruvil Mehta","Dipjyoti Das","Divyansh Seth","Dominic Lim","Dominik Moritz","Dorrin Sotoudeh","EuniceSim142","Frank Kovacs","GK Bishnoi","GURU PRASAD SHARMA","Gaurav","Gautam sharma","Girish Garg","Golden Kumar","Gunj Joshi","Gururaj Gurram","Haroon Rasheed","Harsh","HarshaNP","Harshita Kalani","Hemang Choudhary","Hemant M Mehta","Hridyanshu","Jaimin Godhani","Jaison D Souza","Jalaj Kumar","James Gelok","Jay Soni","Jaysukh Makvana","Jenish Thapa","Jithin KS","Joel Mathew Koshy","Joey Reed","Jordan Gallivan","Joris Labie","Justin Dennison","Justyn Shelby","Karan Anand","Karan Yadav","Karthik Prakash","Kaushikgtm","Kavyansh-Bagdi","Kohantika Nath","Krishnam Agarwal","Krishnendu Das","Kshitij-Dale","Lalit Narayan Yadav","Lovelin Dhoni J B","MANI","Mahfuza Humayra Mohona","Manik Sharma","Manvith M","Marcus Fantham","Matt Cochrane","Mihir Pandit","Milan Raj","Mohammad Bin Aftab","Mohammad Kaif","Momtchil Momtchev","Muhammad Haris","Muhammad Taaha Tariq","Muhmmad Saad","Naresh Jagadeesan","Naveen Kumar","Neeraj Pathak","NirvedMishra","Nishant Shinde","Nishant singh","Nishchay Rajput","Nithin Katta","Nourhan Hasan","Ognjen Jevremović","Oneday12323","Ori Miles","Philipp Burckhardt","Prajjwal Bajpai","Prajwal Kulkarni","Pranav Goswami","Pranjal Jha","Prashant Kumar Yadav","PrathamBhamare","Pratik Singh","Pratyush Kumar Chouhan","Pravesh Kunwar","Priyansh Prajapati","Priyanshu Agarwal","Pulkit Gupta","Pushpendra Chandravanshi","Rahul Kumar","Raunak Kumar Gupta","Rejoan Sardar","Ricky Reusser","Ridam Garg","Rishav","Rishav Tarway","Robert Gislason","Roman Stetsyk","Rupa","Rutam Kathale","Ruthwik Chikoti","Ryan Seal","Rylan Yang","SAHIL KUMAR","SHIVAM YADAV","Sachin Raj","Sahil Goyal","Sai Avinash","Sai Srikar Dumpeti","Sanchay Ketan Sinha","Sarthak Paandey","Saurabh Singh","Seyyed Parsa Neshaei","Shabareesh Shetty","Shashank Shekhar Singh","Shivam Ahir","Shraddheya Shendre","Shubh Mehta","Shubham Mishra","Sivam Das","Snehil Shah","Soumajit Chatterjee","Spandan Barve","Stephannie Jiménez Gacha","Suhaib Ilahi","Suraj Kumar","Swapnil Hajare","Tanishq Ahuja","Tirtadwipa Manunggal","Tudor Pagu","Tufailahmed Bargir","Tushar Bhardwaj","Uday Kakade","Ujjwal Kirti","Utkarsh","Utkarsh Raj","UtkershBasnet","Vaibhav Patel","Vara Rahul Rajana","Varad Gupta","Vinit Pandit","Vivek Maurya","Xiaochuan Ye","Yaswanth Kosuru","Yernar Yergaziyev","Yugal Kaushik","Yuvi Mittal","devshree-bhati","ditsu","ekambains","fadiothman22","iraandrushko","lohithganni","olenkabilonizhka","pranav-1720","rahulrangers","rainn","rei2hu","zhanggy"]
["Aadish Jain","Aarya Balwadkar","Aayush Khanna","Abdelrahman Samir","Abdul Kaium","Abhay Punia","Abhijit Raut","Abhishek Jain","Adarsh Palaskar","Aditya Sapra","Ahmed Atwa","Ahmed Kashkoush","Ahmed Khaled","Aksshay Balasubramanian","Aleksandr","Ali Salesi","AlyAbdelmoneim","Aman Bhansali","AmanBhadkariya","Amit Jimiwal","Anshu Kumar","Anshu Kumar","Anudeep Sanapala","Athan Reines","Ayaka","Bhavishy Agrawal","Brendan Graetz","Bruno Fenzl","Bryan Elee","Chinmay Joshi","Christopher Dambamuromo","Dan Rose","Daniel Killenberger","Daniel Yu","Debashis Maharana","Deep Trivedi","Desh Deepak Kant","Dev Goel","Dhanyabad behera","Dhruv Arvind Singh","Dhruvil Mehta","Dipjyoti Das","Divyansh Seth","Dominic Lim","Dominik Moritz","Dorrin Sotoudeh","EuniceSim142","Frank Kovacs","GK Bishnoi","GURU PRASAD SHARMA","Gaurav","Gautam sharma","Girish Garg","Golden Kumar","Gunj Joshi","Gururaj Gurram","Haroon Rasheed","Harsh","HarshaNP","Harshita Kalani","Hemang Choudhary","Hemant M Mehta","Hridyanshu","Jaimin Godhani","Jaison D Souza","Jalaj Kumar","James Gelok","Jay Soni","Jaysukh Makvana","Jenish Thapa","Jithin KS","Joel Mathew Koshy","Joey Reed","Jordan Gallivan","Joris Labie","Justin Dennison","Justyn Shelby","Karan Anand","Karan Vasudevamurthy","Karan Yadav","Karthik Prakash","Kaushikgtm","Kavyansh-Bagdi","Kohantika Nath","Krishnam Agarwal","Krishnendu Das","Kshitij-Dale","Lalit Narayan Yadav","Lovelin Dhoni J B","MANI","Mahfuza Humayra Mohona","Manik Sharma","Manvith M","Marcus Fantham","Matt Cochrane","Mihir Pandit","Milan Raj","Mohammad Bin Aftab","Mohammad Kaif","Momtchil Momtchev","Muhammad Haris","Muhammad Taaha Tariq","Muhmmad Saad","Naresh Jagadeesan","Naveen Kumar","Neeraj Pathak","NirvedMishra","Nishant Shinde","Nishant singh","Nishchay Rajput","Nithin Katta","Nourhan Hasan","Ognjen Jevremović","Oneday12323","Ori Miles","Philipp Burckhardt","Prajjwal Bajpai","Prajwal Kulkarni","Pranav Goswami","Pranjal Jha","Prashant Kumar Yadav","PrathamBhamare","Pratik Singh","Pratyush Kumar Chouhan","Pravesh Kunwar","Priyansh Prajapati","Priyanshu Agarwal","Pulkit Gupta","Pushpendra Chandravanshi","Rahul Kumar","Raunak Kumar Gupta","Rejoan Sardar","Ricky Reusser","Ridam Garg","Rishav","Rishav Tarway","Robert Gislason","Roman Stetsyk","Rupa","Rutam Kathale","Ruthwik Chikoti","Ryan Seal","Rylan Yang","SAHIL KUMAR","SHIVAM YADAV","Sachin Raj","Sahil Goyal","Sai Avinash","Sai Srikar Dumpeti","Sanchay Ketan Sinha","Sarthak Paandey","Saurabh Singh","Seyyed Parsa Neshaei","Shabareesh Shetty","Shashank Shekhar Singh","Shivam Ahir","Shraddheya Shendre","Shubh Mehta","Shubham Mishra","Sivam Das","Snehil Shah","Soumajit Chatterjee","Spandan Barve","Stephannie Jiménez Gacha","Suhaib Ilahi","Suraj Kumar","Swapnil Hajare","Tanishq Ahuja","Tirtadwipa Manunggal","Tudor Pagu","Tufailahmed Bargir","Tushar Bhardwaj","Uday Kakade","Ujjwal Kirti","Utkarsh","Utkarsh Raj","UtkershBasnet","Vaibhav Patel","Vara Rahul Rajana","Varad Gupta","Vinit Pandit","Vivek Maurya","Xiaochuan Ye","Yaswanth Kosuru","Yernar Yergaziyev","Yugal Kaushik","Yuvi Mittal","devshree-bhati","ditsu","ekambains","fadiothman22","iraandrushko","lohithganni","olenkabilonizhka","pranav-1720","rahulrangers","rainn","rei2hu","zhanggy"]
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 @@ -2552,7 +2552,7 @@ base.uncapitalize,"\nbase.uncapitalize( str )\n Lowercases the first characte
base.uppercase,"\nbase.uppercase( str )\n Converts a string to uppercase.\n\n Parameters\n ----------\n str: string\n Input string.\n\n Returns\n -------\n out: string\n Uppercase string.\n\n Examples\n --------\n > var out = base.uppercase( 'bEEp' )\n 'BEEP'\n\n See Also\n --------\n base.lowercase\n"
base.vercos,"\nbase.vercos( x )\n Computes the versed cosine.\n\n The versed cosine is defined as `1 + cos(x)`.\n\n Parameters\n ----------\n x: number\n Input value (in radians).\n\n Returns\n -------\n y: number\n Versed cosine.\n\n Examples\n --------\n > var y = base.vercos( 3.14 )\n ~0.0\n > y = base.vercos( -4.2 )\n ~0.5097\n > y = base.vercos( -4.6 )\n ~0.8878\n > y = base.vercos( 9.5 )\n ~0.0028\n > y = base.vercos( -0.0 )\n 2.0\n\n See Also\n --------\n base.cos, base.versin\n"
base.versin,"\nbase.versin( x )\n Computes the versed sine.\n\n The versed sine is defined as `1 - cos(x)`.\n\n Parameters\n ----------\n x: number\n Input value (in radians).\n\n Returns\n -------\n y: number\n Versed sine.\n\n Examples\n --------\n > var y = base.versin( 3.14 )\n ~2.0\n > y = base.versin( -4.2 )\n ~1.490\n > y = base.versin( -4.6 )\n ~1.112\n > y = base.versin( 9.5 )\n ~1.997\n > y = base.versin( -0.0 )\n 0.0\n\n See Also\n --------\n base.cos, base.sin, base.vercos\n"
base.wrap,"\nbase.wrap( v, min, max )\n Wraps a value on the half-open interval `[min,max)`.\n\n The function does not distinguish between positive and negative zero. Where\n appropriate, the function returns positive zero.\n\n If provided `NaN` for any argument, the function returns `NaN`.\n\n Parameters\n ----------\n v: number\n Value to wrap.\n\n min: number\n Minimum value.\n\n max: number\n Maximum value.\n\n Returns\n -------\n y: number\n Wrapped value.\n\n Examples\n --------\n > var y = base.wrap( 3.14, 0.0, 5.0 )\n 3.14\n > y = base.wrap( -3.14, 0.0, 5.0 )\n ~1.86\n > y = base.wrap( 3.14, 0.0, 3.0 )\n ~0.14\n > y = base.wrap( -0.0, 0.0, 5.0 )\n 0.0\n > y = base.wrap( 0.0, -3.14, -0.0 )\n -3.14\n > y = base.wrap( NaN, 0.0, 5.0 )\n NaN\n\n See Also\n --------\n base.clamp\n"
base.wrap,"\nbase.wrap( v, min, max )\n Wraps a value to the half-open interval `[min,max)`.\n\n The function does not distinguish between positive and negative zero. Where\n appropriate, the function returns positive zero.\n\n If provided `NaN` for any argument, the function returns `NaN`.\n\n Parameters\n ----------\n v: number\n Value to wrap.\n\n min: number\n Minimum value.\n\n max: number\n Maximum value.\n\n Returns\n -------\n y: number\n Wrapped value.\n\n Examples\n --------\n > var y = base.wrap( 3.14, 0.0, 5.0 )\n 3.14\n > y = base.wrap( -3.14, 0.0, 5.0 )\n ~1.86\n > y = base.wrap( 3.14, 0.0, 3.0 )\n ~0.14\n > y = base.wrap( -0.0, 0.0, 5.0 )\n 0.0\n > y = base.wrap( 0.0, -3.14, -0.0 )\n -3.14\n > y = base.wrap( NaN, 0.0, 5.0 )\n NaN\n\n See Also\n --------\n base.clamp\n"
base.xlog1py,"\nbase.xlog1py( x, y )\n Computes `x * ln(y+1)` so that the result is `0` if `x = 0`.\n\n Parameters\n ----------\n x: number\n Input value.\n\n y: number\n Input value.\n\n Returns\n -------\n out: number\n Function value.\n\n Examples\n --------\n > var out = base.xlog1py( 3.0, 2.0 )\n ~3.296\n > out = base.xlog1py( 1.5, 5.9 )\n ~2.897\n > out = base.xlog1py( 0.9, 1.0 )\n ~0.624\n > out = base.xlog1py( 1.0, 0.0 )\n 0.0\n > out = base.xlog1py( 0.0, -2.0 )\n 0.0\n > out = base.xlog1py( 1.5, NaN )\n NaN\n > out = base.xlog1py( 0.0, NaN )\n NaN\n > out = base.xlog1py( NaN, 2.3 )\n NaN\n\n See Also\n --------\n base.log1p, base.xlogy\n"
base.xlogy,"\nbase.xlogy( x, y )\n Computes `x * ln(y)` so that the result is `0` if `x = 0`.\n\n Parameters\n ----------\n x: number\n Input value.\n\n y: number\n Input value.\n\n Returns\n -------\n out: number\n Function value.\n\n Examples\n --------\n > var out = base.xlogy( 3.0, 2.0 )\n ~2.079\n > out = base.xlogy( 1.5, 5.9 )\n ~2.662\n > out = base.xlogy( 0.9, 1.0 )\n 0.0\n > out = base.xlogy( 0.0, -2.0 )\n 0.0\n > out = base.xlogy( 1.5, NaN )\n NaN\n > out = base.xlogy( 0.0, NaN )\n NaN\n > out = base.xlogy( NaN, 2.3 )\n NaN\n\n See Also\n --------\n base.ln, base.xlog1py\n"
base.zeta,"\nbase.zeta( s )\n Evaluates the Riemann zeta function as a function of a real variable `s`.\n\n Parameters\n ----------\n s: number\n Input value.\n\n Returns\n -------\n y: number\n Function value.\n\n Examples\n --------\n > var y = base.zeta( 1.1 )\n ~10.584\n > y = base.zeta( -4.0 )\n 0.0\n > y = base.zeta( 70.0 )\n 1.0\n > y = base.zeta( 0.5 )\n ~-1.46\n > y = base.zeta( NaN )\n NaN\n\n // Evaluate at a pole:\n > y = base.zeta( 1.0 )\n NaN\n\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 @@ -2552,7 +2552,7 @@ base.uncapitalize,"\nbase.uncapitalize( str:string )\n Lowercases the first c
base.uppercase,"\nbase.uppercase( str:string )\n Converts a string to uppercase.\n"
base.vercos,"\nbase.vercos( x:number )\n Computes the versed cosine.\n"
base.versin,"\nbase.versin( x:number )\n Computes the versed sine.\n"
base.wrap,"\nbase.wrap( v:number, min:number, max:number )\n Wraps a value on the half-open interval `[min,max)`.\n"
base.wrap,"\nbase.wrap( v:number, min:number, max:number )\n Wraps a value to the half-open interval `[min,max)`.\n"
base.xlog1py,"\nbase.xlog1py( x:number, y:number )\n Computes `x * ln(y+1)` so that the result is `0` if `x = 0`.\n"
base.xlogy,"\nbase.xlogy( x:number, y:number )\n Computes `x * ln(y)` so that the result is `0` if `x = 0`.\n"
base.zeta,"\nbase.zeta( s:number )\n Evaluates the Riemann zeta function as a function of a real variable `s`.\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.