[commons-statistics] 03/04: Javadoc parameter range for mu

[ah...@apache.org]

This is an automated email from the ASF dual-hosted git repository.

aherbert pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/commons-statistics.git

commit 7cd381301b4d3d1c23b0bae99719bb9905d6c06f
Author: Alex Herbert <ah...@apache.org>
AuthorDate: Fri Dec 24 14:36:09 2021 +0000

    Javadoc parameter range for mu
---
 .../commons/statistics/distribution/NakagamiDistribution.java       | 6 +++---
 1 file changed, 3 insertions(+), 3 deletions(-)

diff --git a/commons-statistics-distribution/src/main/java/org/apache/commons/statistics/distribution/NakagamiDistribution.java b/commons-statistics-distribution/src/main/java/org/apache/commons/statistics/distribution/NakagamiDistribution.java
index 3bde611..6a11c69 100644
--- a/commons-statistics-distribution/src/main/java/org/apache/commons/statistics/distribution/NakagamiDistribution.java
+++ b/commons-statistics-distribution/src/main/java/org/apache/commons/statistics/distribution/NakagamiDistribution.java
@@ -59,7 +59,7 @@ public final class NakagamiDistribution extends AbstractContinuousDistribution {
     private final double variance;
 
     /**
-     * @param mu Shape parameter.
+     * @param mu Shape parameter (must be positive).
      * @param omega Scale parameter (must be positive). Controls the spread of the distribution.
      */
     private NakagamiDistribution(double mu,
@@ -76,10 +76,10 @@ public final class NakagamiDistribution extends AbstractContinuousDistribution {
     /**
      * Creates a Nakagami distribution.
      *
-     * @param mu Shape parameter.
+     * @param mu Shape parameter (must be positive).
      * @param omega Scale parameter (must be positive). Controls the spread of the distribution.
      * @return the distribution
-     * @throws IllegalArgumentException  if {@code mu < 0.5} or if
+     * @throws IllegalArgumentException  if {@code mu <= 0} or if
      * {@code omega <= 0}.
      */
     public static NakagamiDistribution of(double mu,