Skip to content

Commit e31df35

Browse files
authored
docs: update parameter names
Signed-off-by: Athan <[email protected]>
1 parent 27f923d commit e31df35

File tree

1 file changed

+6
-6
lines changed
  • lib/node_modules/@stdlib/stats/base/variancepn/docs/types

1 file changed

+6
-6
lines changed

lib/node_modules/@stdlib/stats/base/variancepn/docs/types/index.d.ts

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -38,7 +38,7 @@ interface Routine {
3838
* @param N - number of indexed elements
3939
* @param correction - degrees of freedom adjustment
4040
* @param x - input array
41-
* @param stride - stride length
41+
* @param strideX - stride length
4242
* @returns variance
4343
*
4444
* @example
@@ -47,16 +47,16 @@ interface Routine {
4747
* var v = variancepn( x.length, 1, x, 1, 0 );
4848
* // returns ~4.3333
4949
*/
50-
( N: number, correction: number, x: NumericArray | InputArray, stride: number ): number;
50+
( N: number, correction: number, x: NumericArray | InputArray, strideX: number ): number;
5151

5252
/**
5353
* Computes the variance of a strided array using a two-pass algorithm and alternative indexing semantics.
5454
*
5555
* @param N - number of indexed elements
5656
* @param correction - degrees of freedom adjustment
5757
* @param x - input array
58-
* @param stride - stride length
59-
* @param offset - starting index
58+
* @param strideX - stride length
59+
* @param offsetX - starting index
6060
* @returns variance
6161
*
6262
* @example
@@ -65,7 +65,7 @@ interface Routine {
6565
* var v = variancepn.ndarray( x.length, 1, x, 1, 0 );
6666
* // returns ~4.3333
6767
*/
68-
ndarray( N: number, correction: number, x: InputArray, stride: number, offset: number ): number;
68+
ndarray( N: number, correction: number, x: InputArray, strideX: number, offsetX: number ): number;
6969
}
7070

7171
/**
@@ -74,7 +74,7 @@ interface Routine {
7474
* @param N - number of indexed elements
7575
* @param correction - degrees of freedom adjustment
7676
* @param x - input array
77-
* @param stride - stride length
77+
* @param strideX - stride length
7878
* @returns variance
7979
*
8080
* @example

0 commit comments

Comments
 (0)