Skip to content

Commit efad27f

Browse files
committed
docs: update descriptions to use 'Returns' and match JS formatting
1 parent 1fde7c6 commit efad27f

5 files changed

Lines changed: 9 additions & 9 deletions

File tree

lib/node_modules/@stdlib/stats/base/dists/t/variance/README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -157,7 +157,7 @@ for ( i = 0; i < 10; i++ ) {
157157

158158
#### stdlib_base_dists_t_variance( v )
159159

160-
Evaluates the variance for a Student's t-distribution.
160+
Returns the variance for a Student's t-distribution.
161161

162162
```c
163163
double out = stdlib_base_dists_t_variance( 5.0 );
@@ -208,7 +208,7 @@ int main( void ) {
208208
for ( i = 0; i < 25; i++ ) {
209209
v = random_uniform( 2.1, 100.0 );
210210
y = stdlib_base_dists_t_variance( v );
211-
printf( "v: %lf, variance: %lf\n", v, y );
211+
printf( "v: %.4f, Var(X;v): %.4f\n", v, y );
212212
}
213213
}
214214
```

lib/node_modules/@stdlib/stats/base/dists/t/variance/examples/c/example.c

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -33,6 +33,6 @@ int main( void ) {
3333
for ( i = 0; i < 25; i++ ) {
3434
v = random_uniform( 2.1, 100.0 );
3535
y = stdlib_base_dists_t_variance( v );
36-
printf( "v: %lf, variance: %lf\n", v, y );
36+
printf( "v: %.4f, Var(X;v): %.4f\n", v, y );
3737
}
3838
}

lib/node_modules/@stdlib/stats/base/dists/t/variance/include/stdlib/stats/base/dists/t/variance.h

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -27,10 +27,10 @@ extern "C" {
2727
#endif
2828

2929
/**
30-
* Evaluates the variance for a Student's t-distribution with degrees of freedom `v`.
30+
* Returns the variance for a Student's t-distribution with degrees of freedom `v`.
3131
*
3232
* @param v degrees of freedom
33-
* @return evaluated variance
33+
* @return variance
3434
*
3535
* @example
3636
* double y = stdlib_base_dists_t_variance( 5.0 );

lib/node_modules/@stdlib/stats/base/dists/t/variance/lib/native.js

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -26,11 +26,11 @@ var addon = require( './../src/addon.node' );
2626
// MAIN //
2727

2828
/**
29-
* Evaluates the variance for a Student's t-distribution with degrees of freedom `v`.
29+
* Returns the variance for a Student's t-distribution with degrees of freedom `v`.
3030
*
3131
* @private
3232
* @param {number} v - degrees of freedom
33-
* @returns {number} evaluated variance
33+
* @returns {number} variance
3434
*
3535
* @example
3636
* var y = variance( 5.0 );

lib/node_modules/@stdlib/stats/base/dists/t/variance/src/main.c

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -19,10 +19,10 @@
1919
#include "stdlib/math/base/assert/is_nan.h"
2020

2121
/**
22-
* Evaluates the variance for a Student's t-distribution with degrees of freedom `v`.
22+
* Returns the variance for a Student's t-distribution with degrees of freedom `v`.
2323
*
2424
* @param v degrees of freedom
25-
* @return evaluated variance
25+
* @return variance
2626
*
2727
* @example
2828
* double y = stdlib_base_dists_t_variance( 5.0 );

0 commit comments

Comments
 (0)