Commit 9cdfef1
committed
docs: add negative-scale
Adds the `// Negative scale parameter:` `@example` block to the JSDoc
in `lib/main.js` and the `interface CDF` main signature JSDoc in
`docs/types/index.d.ts`. The block documents `cdf( 2.0, 0.0, -1.0 )`
returning `NaN`, which the `sigma <= 0.0` validation guard already
enforces and which the package README and `docs/repl.txt` already
document. The block is present in 4/5 sibling lognormal `(x, mu, sigma)`
packages (`pdf`, `logpdf`, `logcdf`, `quantile`); `cdf` was the lone
outlier at 80% sibling conformance.@example to stats/base/dists/lognormal/cdf
1 parent 8ef0632 commit 9cdfef1
2 files changed
Lines changed: 10 additions & 0 deletions
Lines changed: 5 additions & 0 deletions
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
61 | 61 | | |
62 | 62 | | |
63 | 63 | | |
| 64 | + | |
| 65 | + | |
| 66 | + | |
| 67 | + | |
| 68 | + | |
64 | 69 | | |
65 | 70 | | |
66 | 71 | | |
| |||
Lines changed: 5 additions & 0 deletions
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
54 | 54 | | |
55 | 55 | | |
56 | 56 | | |
| 57 | + | |
| 58 | + | |
| 59 | + | |
| 60 | + | |
| 61 | + | |
57 | 62 | | |
58 | 63 | | |
59 | 64 | | |
| |||
0 commit comments