Auto-generated commit

Author: stdlib-bot

.github/.keepalive

@@ -2,6 +2,6 @@
 
 We are excited about your pull request, but unfortunately we are not accepting pull requests against this repository, as all development happens on the [main project repository](https://github.com/stdlib-js/stdlib). We kindly request that you submit this pull request against the [respective directory](https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/base/sub2ind) of the main repository where we’ll review and provide feedback. 
 
-If this is your first stdlib contribution, be sure to read the [contributing guide](https://github.com/stdlib-js/stdlib/blob/develop/CONTRIBUTING.md) which provides guidelines and instructions for submitting contributions. You may also consult the [development guide](https://github.com/stdlib-js/stdlib/blob/develop/docs/development.md) for help on developing stdlib.
+If this is your first stdlib contribution, be sure to read the [contributing guide](https://github.com/stdlib-js/stdlib/blob/develop/CONTRIBUTING.md) which provides guidelines and instructions for submitting contributions. You may also consult the [development guide](https://github.com/stdlib-js/stdlib/blob/develop/docs/contributing/development.md) for help on developing stdlib.
 
 We look forward to receiving your contribution! :smiley:

.github/PULL_REQUEST_TEMPLATE.md

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

.gitignore

@@ -4,14 +4,16 @@
 
 <section class="release" id="unreleased">
 
-## Unreleased (2025-02-03)
+## Unreleased (2025-12-04)
 
 <section class="commits">
 
 ### Commits
 
 <details>
 
+-   [`ac2734e`](https://github.com/stdlib-js/stdlib/commit/ac2734ecf26371d363be61dbb4f3448c9cb964d4) - **docs:** address lint errors in TSDoc comments _(by Philipp Burckhardt)_
+-   [`6eee151`](https://github.com/stdlib-js/stdlib/commit/6eee15199727d04e3757e66f38384e97b8a333da) - **style:** fix indentation in JSON files _(by Philipp Burckhardt)_
 -   [`2777e4b`](https://github.com/stdlib-js/stdlib/commit/2777e4be161869d09406e3b17947d24c64b47af2) - **bench:** resolve lint errors in benchmarks _(by Athan Reines)_
 
 </details>
@@ -24,9 +26,10 @@
 
 ### Contributors
 
-A total of 1 person contributed to this release. Thank you to this contributor:
+A total of 2 people contributed to this release. Thank you to the following contributors:
 
 -   Athan Reines
+-   Philipp Burckhardt
 
 </section>
 

CHANGELOG.md

@@ -3,127 +3,243 @@
 # Contributors listed in alphabetical order.
 
 Aadish Jain <jain.aadishj@gmail.com>
+Aarya Balwadkar <aaryabalwadkar2005@gmail.com>
 Aayush Khanna <aayushiitbhu23@gmail.com>
+Abdelrahman Samir <60700731+abdelrahman04@users.noreply.github.com>
+Abdul Kaium <97376242+impawstarlight@users.noreply.github.com>
+Abhay Punia <156515195+Hecker165@users.noreply.github.com>
 Abhijit Raut <abhijitmraut8010@gmail.com>
+Abhishek G <166795493+AbhishekG-Codes@users.noreply.github.com>
+Abhishek Jain <40913033+abhishekblue@users.noreply.github.com>
 Adarsh Palaskar <adarshpalaskar99@gmail.com>
 Aditya Sapra <adityaework@gmail.com>
+Aditya Singh <adityasinghk099@gmail.com>
 Ahmed Atwa <Ahmedatwa866@yahoo.com>
 Ahmed Kashkoush <ahmedkashkoush464@gmail.com>
 Ahmed Khaled <kahmd1444@gmail.com>
+Aksshay Balasubramanian <119944779+Aksshay88@users.noreply.github.com>
 Aleksandr <112382387+alextes90@users.noreply.github.com>
 Ali Salesi <ali_sal1381@yahoo.com>
-Aman Bhansali <bhansali.1@iitj.ac.in>
+Aly Abdelmoneim <148393799+AlyAbdelmoneim@users.noreply.github.com>
+Aman Bhadkariya <140033975+AmanBhadkariya@users.noreply.github.com>
+Aman Bhansali <amanbhansali65@gmail.com>
+Amisha Chhajed <amishhhaaaa@gmail.com>
 Amit Jimiwal <amitjimiwal45@gmail.com>
+Anmol Sah <annifind010@gmail.com>
+Annamalai Prabu <apfossdev@gmail.com>
+Anshu Kumar <contact.anshukumar@protonmail.com>
+Anshuman Singh <anshu.1239.as@gmail.com>
 Anudeep Sanapala <anudeep0306@gmail.com>
+Arihant Pal <arihant0pal@gmail.com>
+Aryan Bhirud <112156883+AryanBhirud@users.noreply.github.com>
+Aryan J <18aryanj2006@gmail.com>
 Athan Reines <kgryte@gmail.com>
-Ayaka <73595362+USERSATOSHI@users.noreply.github.com>
+Atharva Patil <anpatil.1223@gmail.com>
+Bhavishy Agrawal <bhavishyrocker2801@gmail.com>
+Bhupesh Kumar <bkumar_be23@thapar.edu>
 Brendan Graetz <bguiz@users.noreply.github.com>
 Bruno Fenzl <brunofenzl@gmail.com>
 Bryan Elee <rxbryn@gmail.com>
 Chinmay Joshi <86140365+JawHawk@users.noreply.github.com>
 Christopher Dambamuromo <chridam@gmail.com>
 Dan Rose <danoftheroses@gmail.com>
+Daniel Hernandez Gomez <156333015+dhernandeez13@users.noreply.github.com>
 Daniel Killenberger <daniel.killenberger@gmail.com>
 Daniel Yu <40680511+Daniel777y@users.noreply.github.com>
 Debashis Maharana <debashismaharana7854@gmail.com>
-Desh Deepak Kant <118960904+DeshDeepakKant@users.noreply.github.com>
+Deep Trivedi <deepbtrivedi04@gmail.com>
+Deepak Singh <78257493+Deepak91168@users.noreply.github.com>
+Deepak Singh <negid0253@gmail.com>
+Desh Deepak Kant <deshdeepakkant@gmail.com>
 Dev Goel <135586571+corsairier@users.noreply.github.com>
+Devshree Bhati <147095250+devshree-bhati@users.noreply.github.com>
+Dhanyabad Behera <dhanyabadbehera@gmail.com>
 Dhruv Arvind Singh <154677013+DhruvArvindSingh@users.noreply.github.com>
-Divyansh Seth <59174836+sethdivyansh@users.noreply.github.com>
+Dhruvil Mehta <dhruvilmehta2606@gmail.com>
+Dipjyoti Das <dipexplorerid23@gmail.com>
+Ditsu S <170345142+ditsus@users.noreply.github.com>
+Divyansh Seth <divyanshseth08@gmail.com>
 Dominic Lim <46486515+domlimm@users.noreply.github.com>
 Dominik Moritz <domoritz@gmail.com>
 Dorrin Sotoudeh <dorrinsotoudeh123@gmail.com>
-EuniceSim142 <77243938+EuniceSim142@users.noreply.github.com>
+Dudhat Hemil Pravinkumar <138382078+Hemil36@users.noreply.github.com>
+Ekampreet Singh Bains <bainsinbusiness@gmail.com>
+Eunice Sim <77243938+EuniceSim142@users.noreply.github.com>
+Fadio <48636283+fadiothman22@users.noreply.github.com>
 Frank Kovacs <fran70kk@gmail.com>
+Gaurav Jadhav <gaurav70380@gmail.com>
+Gaurav Kaushik <144526331+Gauravkaushik-1206@users.noreply.github.com>
+Gautam Kaushik <162317291+Kaushikgtm@users.noreply.github.com>
+Gautam sharma <gautamkrishnasharma1@gmail.com>
+Geo Daoyu <geodaoyu@foxmail.com>
+Girish Garg <garggirish2020@gmail.com>
+Gitty Harsha <hnarayana788@gmail.com>
 Golden Kumar <103646877+AuenKr@users.noreply.github.com>
+Gopi Kishan <gkishan1kyt@gmail.com>
 Gunj Joshi <gunjjoshi8372@gmail.com>
-Gururaj Gurram <143020143+gururaj1512@users.noreply.github.com>
-HarshaNP <96897754+GittyHarsha@users.noreply.github.com>
+Guru Prasad Sharma <168292003+GURUPRASADSHARMA@users.noreply.github.com>
+Gururaj Gurram <gururajgurram1512@gmail.com>
+Harishchandra Reddy <harish.7000@gmail.com>
+Haroon Rasheed <51189276+haroon26@users.noreply.github.com>
+Harsh Yadav <harshyadav6078@gmail.com>
 Harshita Kalani <harshitakalani02@gmail.com>
+Hemang Choudhary <coehemang@gmail.com>
+Hemant M Mehta <92446645+hemantmm@users.noreply.github.com>
 Hridyanshu <124202756+HRIDYANSHU054@users.noreply.github.com>
+Iryna Andrushko <ira.andrushko2@gmail.com>
 Jaimin Godhani <112328542+Jai0401@users.noreply.github.com>
+Jaison Dsouza <jaisondz9360@gmail.com>
+Jalaj Kumar <142599224+jalajk3004@users.noreply.github.com>
 James Gelok <jdgelok@gmail.com>
+Jay Soni <jaygsoni14@gmail.com>
 Jaysukh Makvana <jaysukhmakvana2004@gmail.com>
+Jenish <thisisjenish05@gmail.com>
 Jenish Thapa <141203631+jenish-thapa@users.noreply.github.com>
 Jithin KS <jithinks112@gmail.com>
 Joel Mathew Koshy <joelmathewkoshy@gmail.com>
 Joey Reed <joeyrreed@gmail.com>
 Jordan Gallivan <115050475+Jordan-Gallivan@users.noreply.github.com>
 Joris Labie <joris.labie1@gmail.com>
+jsai28 <54253219+jsai28@users.noreply.github.com>
 Justin Dennison <justin1dennison@gmail.com>
-Karan Anand <119553199+anandkaranubc@users.noreply.github.com>
+Justyn Shelby <96994781+ShelbyJustyn@users.noreply.github.com>
+Karan Anand <anandkarancompsci@gmail.com>
+Karan Vasudevamurthy <karanlvm123@gmail.com>
+Karan Yadav <77043443+karanBRAVO@users.noreply.github.com>
 Karthik Prakash <116057817+skoriop@users.noreply.github.com>
+Kavyansh-Bagdi <153486713+Kavyansh-Bagdi@users.noreply.github.com>
 Kohantika Nath <145763549+kohantikanath@users.noreply.github.com>
+Krishnam Agarwal <83017176+888krishnam@users.noreply.github.com>
 Krishnendu Das <86651039+itskdhere@users.noreply.github.com>
 Kshitij-Dale <152467202+Kshitij-Dale@users.noreply.github.com>
+Lalit Narayan Yadav <162928571+LalitNarayanYadav@users.noreply.github.com>
+lohithganni <116790357+lohithganni@users.noreply.github.com>
+Lokesh Ranjan <lokesh.ranjan.phe23@itbhu.ac.in>
 Lovelin Dhoni J B <100030865+lovelindhoni@users.noreply.github.com>
+Mahfuza Humayra Mohona <mhmohona@gmail.com>
+MANI <77221000+Eternity0207@users.noreply.github.com>
 Manik Sharma <maniksharma.rke@gmail.com>
 Manvith M <148960168+manvith2003@users.noreply.github.com>
 Marcus Fantham <mfantham@users.noreply.github.com>
 Matt Cochrane <matthew.cochrane.eng@gmail.com>
 Mihir Pandit <129577900+MSP20086@users.noreply.github.com>
 Milan Raj <rajsite@users.noreply.github.com>
+Mohammad Bin Aftab <48010758+MohammadBinAftab@users.noreply.github.com>
 Mohammad Kaif <mdkaifprofession@gmail.com>
+Mohsin <122507740+thisisairo@users.noreply.github.com>
 Momtchil Momtchev <momtchil@momtchev.com>
 Muhammad Haris <harriskhan047@outlook.com>
+Muhammad Taaha Tariq <166188821+Taaha-Tariq@users.noreply.github.com>
+Muhmmad Saad <106260977+saad-imran-dev@users.noreply.github.com>
+Nakul Krishnakumar <nakulkrishnakumar86@gmail.com>
 Naresh Jagadeesan <naresh.naresh000@gmail.com>
 Naveen Kumar <stupiddint@gmail.com>
+Navyansh Kesarwani <91735202+navyansh007@users.noreply.github.com>
+navyansh007 <91735202+navyansh007@users.noreply.github.com>
+NEEKUorAAYUSH <aayush10072004@gmail.com>
 Neeraj Pathak <neerajrpathak710@gmail.com>
+NirvedMishra <139633597+NirvedMishra@users.noreply.github.com>
 Nishant Shinde <97207366+nishant-s7@users.noreply.github.com>
+Nishant singh <38534128+Nishantsingh11@users.noreply.github.com>
+Nishchay Rajput <121144841+NishchayRajput@users.noreply.github.com>
 Nithin Katta <88046362+nithinkatta@users.noreply.github.com>
 Nourhan Hasan <109472010+TheNourhan@users.noreply.github.com>
 Ognjen Jevremović <ognjenjevremovic@users.noreply.github.com>
+olenkabilonizhka <62379231+olenkabilonizhka@users.noreply.github.com>
 Oneday12323 <107678750+Oneday12323@users.noreply.github.com>
 Ori Miles <97595296+orimiles5@users.noreply.github.com>
+Payal Goswami <payalgoswami9711@gmail.com>
 Philipp Burckhardt <pburckhardt@outlook.com>
+Pierre Forstmann <15964998+pierreforstmann@users.noreply.github.com>
+Piyush Goel <piyush.goel2704@gmail.com>
+Pradyumn Prasad <pradyumnprasad.567@gmail.com>
+Prajjwal Bajpai <142303989+prajjwalbajpai@users.noreply.github.com>
 Prajwal Kulkarni <prajwalkulkarni76@gmail.com>
-Pranav Goswami <goswami.4@iitj.ac.in>
+Pranav Goswami <pranavchiku11@gmail.com>
+pranav-1720 <123018993+pranav-1720@users.noreply.github.com>
 Pranjal Jha <97080887+PraneGIT@users.noreply.github.com>
 Prashant Kumar Yadav <144602492+0PrashantYadav0@users.noreply.github.com>
+PrathamBhamare <164445568+PrathamBhamare@users.noreply.github.com>
 Pratik Singh <97464067+Pratik772846@users.noreply.github.com>
 Pratyush Kumar Chouhan <pratyushkumar0308@gmail.com>
+Pravesh Kunwar <praveshkunwar04@gmail.com>
 Priyansh Prajapati <88396544+itsspriyansh@users.noreply.github.com>
 Priyanshu Agarwal <113460573+AgPriyanshu18@users.noreply.github.com>
+Pulkit Gupta <65711278+pulkitgupta2@users.noreply.github.com>
 Pushpendra Chandravanshi <pushpendrachandravanshi4@gmail.com>
+Rahul Kumar <132570066+rahulptl165@users.noreply.github.com>
+rahulrangers <127782777+rahulrangers@users.noreply.github.com>
+rainn <88160429+AmCodesLame@users.noreply.github.com>
 Raunak Kumar Gupta <raunakmodanwal321@gmail.com>
+rei2hu <reimu@reimu.ws>
 Rejoan Sardar <119718513+Rejoan-Sardar@users.noreply.github.com>
 Ricky Reusser <rsreusser@gmail.com>
 Ridam Garg <67867319+RidamGarg@users.noreply.github.com>
 Rishav <115060907+rishav2404@users.noreply.github.com>
+Rishav Tarway <rishavtarway@gmail.com>
 Robert Gislason <gztown2216@yahoo.com>
 Roman Stetsyk <25715951+romanstetsyk@users.noreply.github.com>
+RudrakshRaina07 <1819rudraksh@gmail.com>
+Rupa <102663541+Rupa-Rd@users.noreply.github.com>
 Rutam Kathale <138517416+performant23@users.noreply.github.com>
 Ruthwik Chikoti <145591715+ruthwikchikoti@users.noreply.github.com>
 Ryan Seal <splrk@users.noreply.github.com>
 Rylan Yang <137365285+rylany27@users.noreply.github.com>
+Sachin Raj <120590207+schnrj@users.noreply.github.com>
+Sahil Goyal <87982509+sahil20021008@users.noreply.github.com>
+SAHIL KUMAR <168997976+sahilk45@users.noreply.github.com>
+Sai Avinash <120403424+nasarobot@users.noreply.github.com>
 Sai Srikar Dumpeti <80447788+the-r3aper7@users.noreply.github.com>
+Sanchay Ketan Sinha <122982233+satansin123@users.noreply.github.com>
 Sarthak Paandey <145528240+SarthakPaandey@users.noreply.github.com>
+Satyajeet Chavan <chavansatyajeet2004@gmail.com>
+SAUJANYA MAGARDE <162047941+SaujanyaMagarde@users.noreply.github.com>
 Saurabh Singh <saurabhsraghuvanshi@gmail.com>
+Seth-Banker <125103042+Seth-Banker@users.noreply.github.com>
 Seyyed Parsa Neshaei <spneshaei@users.noreply.github.com>
+Shabareesh Shetty <139731143+ShabiShett07@users.noreply.github.com>
 Shashank Shekhar Singh <shashankshekharsingh1205@gmail.com>
+Shaswata Panda <106397517+shaswata-26@users.noreply.github.com>
 Shivam Ahir <11shivam00@gmail.com>
+SHIVAM YADAV <120725381+Shivam-1827@users.noreply.github.com>
+Shivansh <114570926+shiv343@users.noreply.github.com>
 Shraddheya Shendre <shendreshraddheya@gmail.com>
 Shubh Mehta <93862397+Shubh942@users.noreply.github.com>
+Shubham <b4mshubham@gmail.com>
 Shubham Mishra <shubh622005@gmail.com>
+Siddhesh waje <117733253+siddhesh434@users.noreply.github.com>
 Sivam Das <100067002+Sivam2313@users.noreply.github.com>
 Snehil Shah <snehilshah.989@gmail.com>
 Soumajit Chatterjee <121816890+soumajit23@users.noreply.github.com>
 Spandan Barve <contact@marsian.dev>
+Srinivas Batthula <srinivasbatthula05.official@gmail.com>
 Stephannie Jiménez Gacha <steff456@hotmail.com>
+Suhaib Ilahi <suhaib.elahi87@gmail.com>
 Suraj Kumar <125961509+kumarsuraj212003@users.noreply.github.com>
+Swapnil Hajare <69076366+Swapnil-2502@users.noreply.github.com>
+Tanishq Ahuja <68651083+TheGEN1U5@users.noreply.github.com>
 Tirtadwipa Manunggal <tirtadwipa.manunggal@gmail.com>
 Tudor Pagu <104032457+tudor-pagu@users.noreply.github.com>
 Tufailahmed Bargir <142114244+Tufailahmed-Bargir@users.noreply.github.com>
+Tushar Bhardwaj <155543597+TusharBhardwaj441@users.noreply.github.com>
+Tushar Bharti <73595362+USERSATOSHI@users.noreply.github.com>
+Tyson Cung <45380903+tysoncung@users.noreply.github.com>
+Uday Kakade <141299403+udaykakade25@users.noreply.github.com>
+Ujjwal Kirti <64329707+ujjwalkirti@users.noreply.github.com>
 Utkarsh <http://utkarsh11105@gmail.com>
 Utkarsh Raj <rajutkarsh2505@gmail.com>
 UtkershBasnet <119008923+UtkershBasnet@users.noreply.github.com>
 Vaibhav Patel <98279986+noobCoderVP@users.noreply.github.com>
+Vansh Choudhary <iamvanshchaudhary7@gmail.com>
+Vara Rahul Rajana <123227543+rajanarahul93@users.noreply.github.com>
 Varad Gupta <varadgupta21@gmail.com>
 Vinit Pandit <106718914+MeastroZI@users.noreply.github.com>
 Vivek Maurya <vm8118134@gmail.com>
+Wendy Yuchen Sun <wendyyuchensun@gmail.com>
 Xiaochuan Ye <tap91624@gmail.com>
 Yaswanth Kosuru <116426380+yaswanthkosuru@users.noreply.github.com>
 Yernar Yergaziyev <yernar.yergaziyev@erg.kz>
-olenkabilonizhka <62379231+olenkabilonizhka@users.noreply.github.com>
-rainn <88160429+AmCodesLame@users.noreply.github.com>
-rei2hu <reimu@reimu.ws>
+youzi-forge <liuxingyou666@outlook.com>
+Yugal Kaushik <yugalkaushik14@gmail.com>
+Yuvi Mittal <128018763+yuvi-mittal@users.noreply.github.com>
+Zuhair Ahmad <157193652+Zuhair-CS@users.noreply.github.com>

CONTRIBUTORS

@@ -16,6 +16,8 @@
 * limitations under the License.
 */
 
+/* eslint-disable jsdoc/check-param-names */
+
 // TypeScript Version: 4.1
 
 /// <reference types="@stdlib/types"/>
@@ -118,7 +120,7 @@ import { ArrayLike } from '@stdlib/types/array';
 * var shape = [ 3, 3, 3 ];
 * var strides = [ 9, 3, 1 ];
 * var offset = 0;
-* var mode = [ 'throw' ]
+* var mode = [ 'throw' ];
 *
 * var idx = sub2ind( shape, strides, offset, 1, 2, 2, mode );
 * // returns 17