Auto-generated commit

Author: stdlib-bot

.github/.keepalive

@@ -188,7 +188,12 @@ jsconfig.json
 # Other editor files #
 ######################
 .idea/
-
-# Cursor #
-##########
+.cursor
 .cursorignore
+.windsurfrules
+.clinerules
+
+# AI coding agents #
+####################
+CLAUDE.md
+GEMINI.md

.gitignore

@@ -2,6 +2,41 @@
 
 > Package changelog.
 
+<section class="release" id="unreleased">
+
+## Unreleased (2025-12-04)
+
+<section class="commits">
+
+### Commits
+
+<details>
+
+-   [`546d714`](https://github.com/stdlib-js/stdlib/commit/546d71415bfaa6861cb8757741e1c465c7759590) - **docs:** fix example code and return annotations in TSDoc declarations _(by Philipp Burckhardt)_
+-   [`11581aa`](https://github.com/stdlib-js/stdlib/commit/11581aaca8c3cb824cbb92c0c0f80e76890bdb20) - **test:** use standardized assertion messages and fix lint errors _(by Philipp Burckhardt)_
+
+</details>
+
+</section>
+
+<!-- /.commits -->
+
+<section class="contributors">
+
+### Contributors
+
+A total of 1 person contributed to this release. Thank you to this contributor:
+
+-   Philipp Burckhardt
+
+</section>
+
+<!-- /.contributors -->
+
+</section>
+
+<!-- /.release -->
+
 <section class="release" id="v0.2.2">
 
 ## 0.2.2 (2024-07-28)

CHANGELOG.md

@@ -3,81 +3,121 @@
 # Contributors listed in alphabetical order.
 
 Aadish Jain <[email protected]>
+Aarya Balwadkar <[email protected]>
 Aayush Khanna <[email protected]>
 Abdelrahman Samir <[email protected]>
+Abdul Kaium <[email protected]>
 Abhay Punia <[email protected]>
 Abhijit Raut <[email protected]>
+Abhishek G <[email protected]>
 Abhishek Jain <[email protected]>
 Adarsh Palaskar <[email protected]>
 Aditya Sapra <[email protected]>
+Aditya Singh <[email protected]>
 Ahmed Atwa <[email protected]>
 Ahmed Kashkoush <[email protected]>
 Ahmed Khaled <[email protected]>
 Aksshay Balasubramanian <[email protected]>
 Aleksandr <[email protected]>
 Ali Salesi <[email protected]>
-Aman Bhansali <[email protected]>
-AmanBhadkariya <[email protected]>
+Aly Abdelmoneim <[email protected]>
+Aman Bhadkariya <[email protected]>
+Aman Bhansali <[email protected]>
+Amisha Chhajed <[email protected]>
 Amit Jimiwal <[email protected]>
-Anshu Kumar <[email protected]>
+Anmol Sah <[email protected]>
+Annamalai Prabu <[email protected]>
 Anshu Kumar <[email protected]>
+Anshuman Singh <[email protected]>
 Anudeep Sanapala <[email protected]>
+Arihant Pal <[email protected]>
+Aryan Bhirud <[email protected]>
+Aryan J <[email protected]>
 Athan Reines <[email protected]>
-Ayaka <[email protected]>
+Atharva Patil <[email protected]>
+Bhavishy Agrawal <[email protected]>
+Bhupesh Kumar <[email protected]>
 Brendan Graetz <[email protected]>
 Bruno Fenzl <[email protected]>
 Bryan Elee <[email protected]>
 Chinmay Joshi <[email protected]>
 Christopher Dambamuromo <[email protected]>
 Dan Rose <[email protected]>
+Daniel Hernandez Gomez <[email protected]>
 Daniel Killenberger <[email protected]>
 Daniel Yu <[email protected]>
 Debashis Maharana <[email protected]>
-Deep Trivedi <[email protected]>
-Desh Deepak Kant <[email protected]>
+Deep Trivedi <[email protected]>
+Deepak Singh <[email protected]>
+Deepak Singh <[email protected]>
+Desh Deepak Kant <[email protected]>
 Dev Goel <[email protected]>
-Dhanyabad behera <[email protected]>
+Devshree Bhati <[email protected]>
+Dhanyabad Behera <[email protected]>
 Dhruv Arvind Singh <[email protected]>
-Dhruvil Mehta <[email protected]>
-Divyansh Seth <[email protected]>
+Dhruvil Mehta <[email protected]>
+Dipjyoti Das <[email protected]>
+Ditsu S <[email protected]>
+Divyansh Seth <[email protected]>
 Dominic Lim <[email protected]>
 Dominik Moritz <[email protected]>
 Dorrin Sotoudeh <[email protected]>
-EuniceSim142 <[email protected]>
+Dudhat Hemil Pravinkumar <[email protected]>
+Ekampreet Singh Bains <[email protected]>
+Eunice Sim <[email protected]>
+Fadio <[email protected]>
 Frank Kovacs <[email protected]>
-GK Bishnoi <[email protected]>
-Gaurav <[email protected]>
+Gaurav Jadhav <[email protected]>
+Gaurav Kaushik <[email protected]>
+Gautam Kaushik <[email protected]>
 Gautam sharma <[email protected]>
+Geo Daoyu <[email protected]>
+Girish Garg <[email protected]>
+Gitty Harsha <[email protected]>
 Golden Kumar <[email protected]>
+Gopi Kishan <[email protected]>
 Gunj Joshi <[email protected]>
+Guru Prasad Sharma <[email protected]>
 Gururaj Gurram <[email protected]>
+Harishchandra Reddy <[email protected]>
 Haroon Rasheed <[email protected]>
-Harsh <[email protected]>
-HarshaNP <[email protected]>
+Harsh Yadav <[email protected]>
 Harshita Kalani <[email protected]>
+Hemang Choudhary <[email protected]>
 Hemant M Mehta <[email protected]>
 Hridyanshu <[email protected]>
+Iryna Andrushko <[email protected]>
 Jaimin Godhani <[email protected]>
-Jaison D Souza <[email protected].com>
+Jaison Dsouza <jaisondz9360@gmail.com>
 Jalaj Kumar <[email protected]>
 James Gelok <[email protected]>
+Jay Soni <[email protected]>
 Jaysukh Makvana <[email protected]>
+Jenish <[email protected]>
 Jenish Thapa <[email protected]>
 Jithin KS <[email protected]>
 Joel Mathew Koshy <[email protected]>
 Joey Reed <[email protected]>
 Jordan Gallivan <[email protected]>
 Joris Labie <[email protected]>
+jsai28 <[email protected]>
 Justin Dennison <[email protected]>
 Justyn Shelby <[email protected]>
-Karan Anand <[email protected]>
+Karan Anand <[email protected]>
+Karan Vasudevamurthy <[email protected]>
+Karan Yadav <[email protected]>
 Karthik Prakash <[email protected]>
-Kaushikgtm <162317291+Kaushikgtm@users.noreply.github.com>
+Kavyansh-Bagdi <153486713+Kavyansh-Bagdi@users.noreply.github.com>
 Kohantika Nath <[email protected]>
 Krishnam Agarwal <[email protected]>
 Krishnendu Das <[email protected]>
 Kshitij-Dale <[email protected]>
+Lalit Narayan Yadav <[email protected]>
+lohithganni <[email protected]>
+Lokesh Ranjan <[email protected]>
 Lovelin Dhoni J B <[email protected]>
+Mahfuza Humayra Mohona <[email protected]>
+MANI <[email protected]>
 Manik Sharma <[email protected]>
 Manvith M <[email protected]>
 Marcus Fantham <[email protected]>
@@ -86,79 +126,120 @@ Mihir Pandit <[email protected]>
 Milan Raj <[email protected]>
 Mohammad Bin Aftab <[email protected]>
 Mohammad Kaif <[email protected]>
+Mohsin <[email protected]>
 Momtchil Momtchev <[email protected]>
 Muhammad Haris <[email protected]>
+Muhammad Taaha Tariq <[email protected]>
+Muhmmad Saad <[email protected]>
+Nakul Krishnakumar <[email protected]>
 Naresh Jagadeesan <[email protected]>
 Naveen Kumar <[email protected]>
+Navyansh Kesarwani <[email protected]>
+navyansh007 <[email protected]>
+NEEKUorAAYUSH <[email protected]>
 Neeraj Pathak <[email protected]>
+NirvedMishra <[email protected]>
 Nishant Shinde <[email protected]>
+Nishant singh <[email protected]>
 Nishchay Rajput <[email protected]>
 Nithin Katta <[email protected]>
 Nourhan Hasan <[email protected]>
 Ognjen Jevremović <[email protected]>
+olenkabilonizhka <[email protected]>
 Oneday12323 <[email protected]>
 Ori Miles <[email protected]>
+Payal Goswami <[email protected]>
 Philipp Burckhardt <[email protected]>
+Pierre Forstmann <[email protected]>
+Piyush Goel <[email protected]>
+Pradyumn Prasad <[email protected]>
+Prajjwal Bajpai <[email protected]>
 Prajwal Kulkarni <[email protected]>
 Pranav Goswami <[email protected]>
+pranav-1720 <[email protected]>
 Pranjal Jha <[email protected]>
 Prashant Kumar Yadav <[email protected]>
+PrathamBhamare <[email protected]>
 Pratik Singh <[email protected]>
 Pratyush Kumar Chouhan <[email protected]>
+Pravesh Kunwar <[email protected]>
 Priyansh Prajapati <[email protected]>
 Priyanshu Agarwal <[email protected]>
+Pulkit Gupta <[email protected]>
 Pushpendra Chandravanshi <[email protected]>
+Rahul Kumar <[email protected]>
+rahulrangers <[email protected]>
+rainn <[email protected]>
 Raunak Kumar Gupta <[email protected]>
+rei2hu <[email protected]>
 Rejoan Sardar <[email protected]>
 Ricky Reusser <[email protected]>
 Ridam Garg <[email protected]>
 Rishav <[email protected]>
 Rishav Tarway <[email protected]>
 Robert Gislason <[email protected]>
 Roman Stetsyk <[email protected]>
+RudrakshRaina07 <[email protected]>
+Rupa <[email protected]>
 Rutam Kathale <[email protected]>
 Ruthwik Chikoti <[email protected]>
 Ryan Seal <[email protected]>
 Rylan Yang <[email protected]>
-SHIVAM YADAV <[email protected]>
+Sachin Raj <[email protected]>
+Sahil Goyal <[email protected]>
+SAHIL KUMAR <[email protected]>
+Sai Avinash <[email protected]>
 Sai Srikar Dumpeti <[email protected]>
+Sanchay Ketan Sinha <[email protected]>
 Sarthak Paandey <[email protected]>
+Satyajeet Chavan <[email protected]>
+SAUJANYA MAGARDE <[email protected]>
 Saurabh Singh <[email protected]>
+Seth-Banker <[email protected]>
 Seyyed Parsa Neshaei <[email protected]>
 Shabareesh Shetty <[email protected]>
 Shashank Shekhar Singh <[email protected]>
+Shaswata Panda <[email protected]>
 Shivam Ahir <[email protected]>
+SHIVAM YADAV <[email protected]>
+Shivansh <[email protected]>
 Shraddheya Shendre <[email protected]>
 Shubh Mehta <[email protected]>
+Shubham <[email protected]>
 Shubham Mishra <[email protected]>
+Siddhesh waje <[email protected]>
 Sivam Das <[email protected]>
 Snehil Shah <[email protected]>
 Soumajit Chatterjee <[email protected]>
 Spandan Barve <[email protected]>
+Srinivas Batthula <[email protected]>
 Stephannie Jiménez Gacha <[email protected]>
 Suhaib Ilahi <[email protected]>
 Suraj Kumar <[email protected]>
+Swapnil Hajare <[email protected]>
 Tanishq Ahuja <[email protected]>
 Tirtadwipa Manunggal <[email protected]>
 Tudor Pagu <[email protected]>
 Tufailahmed Bargir <[email protected]>
+Tushar Bhardwaj <[email protected]>
+Tushar Bharti <[email protected]>
+Tyson Cung <[email protected]>
+Uday Kakade <[email protected]>
+Ujjwal Kirti <[email protected]>
 Utkarsh <http://[email protected]>
 Utkarsh Raj <[email protected]>
 UtkershBasnet <[email protected]>
 Vaibhav Patel <[email protected]>
+Vansh Choudhary <[email protected]>
+Vara Rahul Rajana <[email protected]>
 Varad Gupta <[email protected]>
 Vinit Pandit <[email protected]>
 Vivek Maurya <[email protected]>
+Wendy Yuchen Sun <[email protected]>
 Xiaochuan Ye <[email protected]>
 Yaswanth Kosuru <[email protected]>
 Yernar Yergaziyev <[email protected]>
+youzi-forge <[email protected]>
 Yugal Kaushik <[email protected]>
 Yuvi Mittal <[email protected]>
-ditsu <[email protected]>
-ekambains <[email protected]>
-fadiothman22 <[email protected]>
-olenkabilonizhka <[email protected]>
-pranav-1720 <[email protected]>
-rahulrangers <[email protected]>
-rainn <[email protected]>
-rei2hu <[email protected]>
+Zuhair Ahmad <[email protected]>

CONTRIBUTORS

@@ -31,8 +31,6 @@ import { Collection } from '@stdlib/types/array';
 * @returns new `Buffer` instance
 *
 * @example
-* var fromArray = require( '@stdlib/buffer-from-array' );
-*
 * var buf = fromArray( [ 1, 2, 3, 4 ] );
 * // returns <Buffer>
 */

docs/types/index.d.ts

@@ -93,7 +93,7 @@ tape( 'the function allocates a buffer using an octet array (array)', function t
 	arr = [ 1, 2, 3, 4 ];
 	buf = array2buffer( arr );
 
-	t.strictEqual( isBuffer( buf ), true, 'returns a buffer' );
+	t.strictEqual( isBuffer( buf ), true, 'returns expected value' );
 
 	for ( i = 0; i < arr.length; i++ ) {
 		t.strictEqual( buf[ i ], arr[ i ], 'returns expected value for element ' + i );
@@ -109,7 +109,7 @@ tape( 'the function allocates a buffer using an octet array (typed array)', func
 	arr = new Uint8Array( [ 1, 2, 3, 4 ] );
 	buf = array2buffer( arr );
 
-	t.strictEqual( isBuffer( buf ), true, 'returns a buffer' );
+	t.strictEqual( isBuffer( buf ), true, 'returns expected value' );
 
 	for ( i = 0; i < arr.length; i++ ) {
 		t.strictEqual( buf[ i ], arr[ i ], 'returns expected value for element ' + i );
@@ -131,7 +131,7 @@ tape( 'the function allocates a buffer using an octet array (array-like)', funct
 	};
 	buf = array2buffer( arr );
 
-	t.strictEqual( isBuffer( buf ), true, 'returns a buffer' );
+	t.strictEqual( isBuffer( buf ), true, 'returns expected value' );
 
 	for ( i = 0; i < arr.length; i++ ) {
 		t.strictEqual( buf[ i ], arr[ i ], 'returns expected value for element ' + i );
@@ -141,7 +141,7 @@ tape( 'the function allocates a buffer using an octet array (array-like)', funct
 
 tape( 'if provided an empty array, the function returns an empty buffer', function test( t ) {
 	var buf = array2buffer( [] );
-	t.strictEqual( isBuffer( buf ), true, 'returns a buffer' );
+	t.strictEqual( isBuffer( buf ), true, 'returns expected value' );
 	t.strictEqual( buf.length, 0, 'has expected length' );
 	t.end();
 });