Skip to content

Commit 460014c

Browse files
committed
docs: add domain constraint to @stdlib/stats/base/dists/chisquare/mean intro
The intro section previously read "where \`k\` is the degrees of freedom"; updated to "where \`k >= 0\` is the degrees of freedom" to match the convention used by the three other `NonNegativeNumber`-domain siblings in this namespace (`mode`, `stdev`, `variance` — 3/4 = 75% conformance). The constraint matches the existing Notes statement "If provided \`k < 0\`, the function returns \`NaN\`" found later in the same file.
1 parent 8868c50 commit 460014c

1 file changed

Lines changed: 1 addition & 1 deletion

File tree

  • lib/node_modules/@stdlib/stats/base/dists/chisquare/mean

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -41,7 +41,7 @@ The [expected value][expected-value] for a [chi-squared][chisquare-distribution]
4141

4242
<!-- </equation> -->
4343

44-
where `k` is the degrees of freedom.
44+
where `k >= 0` is the degrees of freedom.
4545

4646
</section>
4747

0 commit comments

Comments
 (0)