Skip to content

Commit 8868c50

Browse files
committed
docs: normalize example variable naming in @stdlib/stats/base/dists/chisquare/median
Replaced `var y` and `var k` with `var v` in the negative-input and NaN `@example` blocks so the package matches the convention used by all seven single-argument sibling distribution packages (`entropy`, `kurtosis`, `mean`, `mode`, `skewness`, `stdev`, `variance`), where `var v = <pkg>( ... );` appears uniformly across all four examples in both the README and the TypeScript declaration file (87.5% conformance). The package's own `lib/main.js` already uses `var v` throughout, so the divergence was confined to `README.md` and `docs/types/index.d.ts`.
1 parent 58bbb07 commit 8868c50

2 files changed

Lines changed: 3 additions & 3 deletions

File tree

lib/node_modules/@stdlib/stats/base/dists/chisquare/median/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -55,7 +55,7 @@ v = median( 2.0 );
5555
If provided `k < 0`, the function returns `NaN`.
5656

5757
```javascript
58-
var y = median( -1.0 );
58+
var v = median( -1.0 );
5959
// returns NaN
6060
```
6161

lib/node_modules/@stdlib/stats/base/dists/chisquare/median/docs/types/index.d.ts

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -37,11 +37,11 @@
3737
* // returns ~1.386
3838
*
3939
* @example
40-
* var k = median( -0.2 );
40+
* var v = median( -0.2 );
4141
* // returns NaN
4242
*
4343
* @example
44-
* var k = median( NaN );
44+
* var v = median( NaN );
4545
* // returns NaN
4646
*/
4747
declare function median( k: number ): number;

0 commit comments

Comments
 (0)