Skip to content

Commit baaf981

Browse files
committed
docs: fix parameter descriptions in stats/base/dists/lognormal/quantile
Propagates fix from 9fedcf9 ("docs: fix parameter descriptions in `stats/base/dists/lognormal`") to the top-level quantile JSDoc in `stats/base/dists/lognormal/quantile/docs/types/index.d.ts` that still labeled `mu` as "mean" and `sigma` as "standard deviation". For the lognormal distribution, `mu` and `sigma` are the location and scale parameters of the underlying normal, not the mean/std of the lognormal itself. The matching JSDoc blocks in `stats/base/dists/lognormal/docs/types/ index.d.ts` were dropped from this propagation: that file fails the TypeScript-declarations lint on pre-existing example value mismatches in the `logpdf` block (lines 176/179, introduced in cfc58ab) which are out of scope for this fix.
1 parent ba7a157 commit baaf981

1 file changed

Lines changed: 2 additions & 2 deletions

File tree

  • lib/node_modules/@stdlib/stats/base/dists/lognormal/quantile/docs/types

lib/node_modules/@stdlib/stats/base/dists/lognormal/quantile/docs/types/index.d.ts

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -104,8 +104,8 @@ interface Quantile {
104104
* Lognormal distribution quantile function.
105105
*
106106
* @param p - input value
107-
* @param mu - mean
108-
* @param sigma - standard deviation
107+
* @param mu - location parameter
108+
* @param sigma - scale parameter
109109
* @returns evaluated quantile function
110110
*
111111
* @example

0 commit comments

Comments
 (0)