[commons-statistics] 01/03: Javadoc that the scale parameter controls the spread.

[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 533e9cb64b80ffc24bba796107bad929b71e461e
Author: aherbert <ah...@apache.org>
AuthorDate: Wed Sep 22 10:55:00 2021 +0100

    Javadoc that the scale parameter controls the spread.
    
    The distribution omega parameter may be known as the spread in other
    references.
---
 .../apache/commons/statistics/distribution/NakagamiDistribution.java  | 4 ++--
 1 file changed, 2 insertions(+), 2 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 b71c41a..c17f034 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
@@ -45,8 +45,8 @@ public class NakagamiDistribution extends AbstractContinuousDistribution {
     /**
      * Creates a distribution.
      *
-     * @param mu shape parameter
-     * @param omega scale parameter (must be positive)
+     * @param mu Shape parameter.
+     * @param omega Scale parameter (must be positive). Controls the spread of the distribution.
      * @throws IllegalArgumentException  if {@code mu < 0.5} or if
      * {@code omega <= 0}.
      */