Skip to content

Commit fba5621

Browse files
committed
refactor: annotate parameters as constants and fix docs
1 parent 02c425d commit fba5621

File tree

3 files changed

+3
-3
lines changed

3 files changed

+3
-3
lines changed

lib/node_modules/@stdlib/strided/base/stride2offset/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -144,7 +144,7 @@ int64_t offset = stdlib_strided_stride2offset( 10, -10 );
144144
The function accepts the following arguments:
145145

146146
- **N**: `[in] int64_t` number of indexed elements.
147-
- **stride** `[in] int64_t` index increment.
147+
- **stride**: `[in] int64_t` index increment.
148148

149149
```c
150150
int64_t stdlib_strided_stride2offset( int64_t N, int64_t stride );

lib/node_modules/@stdlib/strided/base/stride2offset/include/stdlib/strided/base/stride2offset.h

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,7 @@ extern "C" {
3131
/**
3232
* Returns the index offset which specifies the location of the first indexed value in a strided array.
3333
*/
34-
int64_t stdlib_strided_stride2offset( int64_t N, int64_t stride );
34+
int64_t stdlib_strided_stride2offset( const int64_t N, const int64_t stride );
3535

3636
#ifdef __cplusplus
3737
}

lib/node_modules/@stdlib/strided/base/stride2offset/src/main.c

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,7 @@
3333
* int64_t offset = stdlib_strided_stride2offset( 10, -10 );
3434
* // returns 90
3535
*/
36-
int64_t stdlib_strided_stride2offset( int64_t N, int64_t stride ) {
36+
int64_t stdlib_strided_stride2offset( const int64_t N, const int64_t stride ) {
3737
if ( stride > 0 ) {
3838
return 0;
3939
}

0 commit comments

Comments
 (0)