Skip to content

Commit 1b02fdc

Browse files
committed
Auto-generated commit
1 parent 68cf41a commit 1b02fdc

File tree

8 files changed

+24
-18
lines changed

8 files changed

+24
-18
lines changed

.editorconfig

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -121,7 +121,7 @@ indent_style = tab
121121
[*.{md,md.txt}]
122122
indent_style = space
123123
indent_size = 4
124-
trim_trailing_whitespace = false
124+
trim_trailing_whitespace = true # Note: this disables using two spaces to force a hard line break, which is permitted in Markdown. As we don't typically follow that practice (TMK), we should be safe to automatically trim.
125125
126126
# Set properties for `usage.txt` files:
127127
[usage.txt]

.github/workflows/test_install.yml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -50,8 +50,8 @@ jobs:
5050
env:
5151
SLACK_WEBHOOK_URL: ${{ secrets.SLACK_WEBHOOK_URL }}
5252

53-
# Run workflow job if `publish` workflow run is successful or when the workflow is manually run:
54-
if: ${{ github.event.workflow_run.conclusion == 'success' || github.event_name == 'workflow_dispatch' }}
53+
# Run workflow job if `publish` workflow run is successful or when the workflow is manually triggered or on a schedule:
54+
if: ${{ github.event.workflow_run.conclusion == 'success' || github.event_name == 'workflow_dispatch' || github.event_name == 'schedule' }}
5555

5656
# Define the sequence of job steps...
5757
steps:

.github/workflows/test_published_package.yml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -47,8 +47,8 @@ jobs:
4747
env:
4848
SLACK_WEBHOOK_URL: ${{ secrets.SLACK_WEBHOOK_URL }}
4949

50-
# Run workflow job if `publish` workflow run is successful or when the workflow is manually run:
51-
if: ${{ github.event.workflow_run.conclusion == 'success' || github.event_name == 'workflow_dispatch' }}
50+
# Run workflow job if `publish` workflow run is successful or when the workflow is manually triggered or on a schedule:
51+
if: ${{ github.event.workflow_run.conclusion == 'success' || github.event_name == 'workflow_dispatch' || github.event_name == 'schedule' }}
5252

5353
# Define the job's steps:
5454
steps:

CHANGELOG.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44
55
<section class="release" id="unreleased">
66

7-
## Unreleased (2024-12-14)
7+
## Unreleased (2025-01-02)
88

99
<section class="features">
1010

@@ -22,6 +22,8 @@
2222

2323
<details>
2424

25+
- [`f8777ec`](https://github.com/stdlib-js/stdlib/commit/f8777ec116247e8481a20c0798dccfa90baa6171) - **docs:** fix grammar _(by Athan Reines)_
26+
- [`2bde288`](https://github.com/stdlib-js/stdlib/commit/2bde288643491a4c317a02fe6b835c81e05e2235) - **docs:** fix grammar _(by Athan Reines)_
2527
- [`07c9202`](https://github.com/stdlib-js/stdlib/commit/07c92021666d2b439a239397d54a43e5785b3360) - **refactor:** remove unnecessary variable _(by Athan Reines)_
2628
- [`855b8c2`](https://github.com/stdlib-js/stdlib/commit/855b8c255abba003e9505aa3a80105a2e2b6b3a7) - **docs:** add example _(by Athan Reines)_
2729
- [`1cc3e09`](https://github.com/stdlib-js/stdlib/commit/1cc3e095080947f8fdd61ea2217f9b3031b9f93b) - **docs:** fix annotation _(by Athan Reines)_

CONTRIBUTORS

Lines changed: 11 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -2,12 +2,14 @@
22
#
33
# Contributors listed in alphabetical order.
44

5+
Aadish Jain <[email protected]>
56
Aayush Khanna <[email protected]>
67
Abhijit Raut <[email protected]>
78
Adarsh Palaskar <[email protected]>
89
Aditya Sapra <[email protected]>
910
Ahmed Atwa <[email protected]>
1011
Ahmed Kashkoush <[email protected]>
12+
Ahmed Khaled <[email protected]>
1113
Aleksandr <[email protected]>
1214
Ali Salesi <[email protected]>
1315
Aman Bhansali <[email protected]>
@@ -24,6 +26,8 @@ Dan Rose <[email protected]>
2426
Daniel Killenberger <[email protected]>
2527
Daniel Yu <[email protected]>
2628
Debashis Maharana <[email protected]>
29+
Desh Deepak Kant <[email protected]>
30+
Divyansh Seth <[email protected]>
2731
Dominic Lim <[email protected]>
2832
Dominik Moritz <[email protected]>
2933
Dorrin Sotoudeh <[email protected]>
@@ -46,11 +50,10 @@ Jordan Gallivan <[email protected]>
4650
Joris Labie <[email protected]>
4751
Justin Dennison <[email protected]>
4852
Karthik Prakash <[email protected]>
49-
5053
Kohantika Nath <[email protected]>
5154
Krishnendu Das <[email protected]>
5255
Kshitij-Dale <[email protected]>
53-
56+
Lovelin Dhoni J B <[email protected]>
5457
Manik Sharma <[email protected]>
5558
Manvith M <[email protected]>
5659
Marcus Fantham <[email protected]>
@@ -61,6 +64,7 @@ Mohammad Kaif <[email protected]>
6164
Momtchil Momtchev <[email protected]>
6265
Muhammad Haris <[email protected]>
6366
Naresh Jagadeesan <[email protected]>
67+
Naveen Kumar <[email protected]>
6468
Neeraj Pathak <[email protected]>
6569
Nishant Shinde <[email protected]>
6670
Nithin Katta <[email protected]>
@@ -71,10 +75,11 @@ Ori Miles <[email protected]>
7175
Philipp Burckhardt <[email protected]>
7276
Prajwal Kulkarni <[email protected]>
7377
Pranav Goswami <[email protected]>
74-
75-
78+
Pranjal Jha <[email protected]>
79+
Prashant Kumar Yadav <[email protected]>
80+
Pratik Singh <[email protected]>
7681
Pratyush Kumar Chouhan <[email protected]>
77-
82+
Priyansh Prajapati <[email protected]>
7883
Priyanshu Agarwal <[email protected]>
7984
Pushpendra Chandravanshi <[email protected]>
8085
Raunak Kumar Gupta <[email protected]>
@@ -93,7 +98,7 @@ Sarthak Paandey <[email protected]>
9398
Saurabh Singh <[email protected]>
9499
Seyyed Parsa Neshaei <[email protected]>
95100
Shashank Shekhar Singh <[email protected]>
96-
101+
Shivam Ahir <[email protected]>
97102
Shraddheya Shendre <[email protected]>
98103
Shubh Mehta <[email protected]>
99104
Shubham Mishra <[email protected]>
@@ -116,7 +121,6 @@ Vivek maurya <[email protected]>
116121
Xiaochuan Ye <[email protected]>
117122
Yaswanth Kosuru <[email protected]>
118123
Yernar Yergaziyev <[email protected]>
119-
120124
olenkabilonizhka <[email protected]>
121125
122126

README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -109,7 +109,7 @@ The function accepts the following arguments:
109109
The function accepts the following options:
110110

111111
- **dtype**: output ndarray [data type][@stdlib/ndarray/dtypes]. If not specified, the output ndarray [data type][@stdlib/ndarray/dtypes] is inferred from the input [ndarray][@stdlib/ndarray/ctor].
112-
- **order**: index iteration order. By default, the function iterates over elements according to the [layout order][@stdlib/ndarray/orders] of the provided [ndarray][@stdlib/ndarray/ctor]. Accordingly, for row-major input [ndarrays][@stdlib/ndarray/ctor], the last dimension indices increment fastest. For column-major input [ndarrays][@stdlib/ndarray/ctor], the first dimension indices increment fastest. To override the inferred order and ensure that indices increment in a specific manor, regardless of the input [ndarray][@stdlib/ndarray/ctor]'s layout order, explicitly set the iteration order. Note, however, that iterating according to an order which does not match that of the input [ndarray][@stdlib/ndarray/ctor] may, in some circumstances, result in performance degradation due to cache misses. Must be either `'row-major'` or `'column-major'`.
112+
- **order**: index iteration order. By default, the function iterates over elements according to the [layout order][@stdlib/ndarray/orders] of the provided [ndarray][@stdlib/ndarray/ctor]. Accordingly, for row-major input [ndarrays][@stdlib/ndarray/ctor], the last dimension indices increment fastest. For column-major input [ndarrays][@stdlib/ndarray/ctor], the first dimension indices increment fastest. To override the inferred order and ensure that indices increment in a specific manner, regardless of the input [ndarray][@stdlib/ndarray/ctor]'s layout order, explicitly set the iteration order. Note, however, that iterating according to an order which does not match that of the input [ndarray][@stdlib/ndarray/ctor] may, in some circumstances, result in performance degradation due to cache misses. Must be either `'row-major'` or `'column-major'`.
113113

114114
By default, the output ndarray [data type][@stdlib/ndarray/dtypes] is inferred from the input [ndarray][@stdlib/ndarray/ctor]. To return an ndarray with a different [data type][@stdlib/ndarray/dtypes], specify the `dtype` option.
115115

@@ -265,7 +265,7 @@ See [LICENSE][stdlib-license].
265265

266266
## Copyright
267267

268-
Copyright &copy; 2016-2024. The Stdlib [Authors][stdlib-authors].
268+
Copyright &copy; 2016-2025. The Stdlib [Authors][stdlib-authors].
269269

270270
</section>
271271

docs/repl.txt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@
2727
row-major input arrays, the last dimension indices increment fastest.
2828
For column-major input arrays, the first dimension indices increment
2929
fastest. To override the inferred order and ensure that indices
30-
increment in a specific manor, regardless of the input array's layout
30+
increment in a specific manner, regardless of the input array's layout
3131
order, explicitly set the iteration order. Note, however, that iterating
3232
according to an order which does not match that of the input array may,
3333
in some circumstances, result in performance degradation due to cache

docs/types/index.d.ts

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -78,7 +78,7 @@ interface BaseOptions {
7878
*
7979
* ## Notes
8080
*
81-
* - By default, the function iterates over elements according to the layout order of the provided ndarray. Accordingly, for row-major input ndarrays, the last dimension indices increment fastest. For column-major input ndarrays, the first dimension indices increment fastest. To override the inferred order and ensure that indices increment in a specific manor, regardless of the input ndarray's layout order, explicitly set the iteration order. Note, however, that iterating according to an order which does not match that of the input ndarray may, in some circumstances, result in performance degradation due to cache misses.
81+
* - By default, the function iterates over elements according to the layout order of the provided ndarray. Accordingly, for row-major input ndarrays, the last dimension indices increment fastest. For column-major input ndarrays, the first dimension indices increment fastest. To override the inferred order and ensure that indices increment in a specific manner, regardless of the input ndarray's layout order, explicitly set the iteration order. Note, however, that iterating according to an order which does not match that of the input ndarray may, in some circumstances, result in performance degradation due to cache misses.
8282
*/
8383
order?: Order;
8484
}
@@ -92,7 +92,7 @@ interface OrderOptions {
9292
*
9393
* ## Notes
9494
*
95-
* - By default, the function iterates over elements according to the layout order of the provided ndarray. Accordingly, for row-major input ndarrays, the last dimension indices increment fastest. For column-major input ndarrays, the first dimension indices increment fastest. To override the inferred order and ensure that indices increment in a specific manor, regardless of the input ndarray's layout order, explicitly set the iteration order. Note, however, that iterating according to an order which does not match that of the input ndarray may, in some circumstances, result in performance degradation due to cache misses.
95+
* - By default, the function iterates over elements according to the layout order of the provided ndarray. Accordingly, for row-major input ndarrays, the last dimension indices increment fastest. For column-major input ndarrays, the first dimension indices increment fastest. To override the inferred order and ensure that indices increment in a specific manner, regardless of the input ndarray's layout order, explicitly set the iteration order. Note, however, that iterating according to an order which does not match that of the input ndarray may, in some circumstances, result in performance degradation due to cache misses.
9696
*/
9797
order: Order;
9898
}

0 commit comments

Comments
 (0)