You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@commons.apache.org by ah...@apache.org on 2023/04/02 12:29:39 UTC
[commons-statistics] branch master updated: Javadoc corrections for package-private elements
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
The following commit(s) were added to refs/heads/master by this push:
new 9191a8d Javadoc corrections for package-private elements
9191a8d is described below
commit 9191a8dedb0b32a32e48763270bb7aadf81a3afd
Author: Alex Herbert <ah...@apache.org>
AuthorDate: Sun Apr 2 13:29:18 2023 +0100
Javadoc corrections for package-private elements
---
.../commons/statistics/distribution/DistributionException.java | 10 +++++-----
.../statistics/distribution/SaddlePointExpansionUtils.java | 2 --
2 files changed, 5 insertions(+), 7 deletions(-)
diff --git a/commons-statistics-distribution/src/main/java/org/apache/commons/statistics/distribution/DistributionException.java b/commons-statistics-distribution/src/main/java/org/apache/commons/statistics/distribution/DistributionException.java
index cc477bd..e44708c 100644
--- a/commons-statistics-distribution/src/main/java/org/apache/commons/statistics/distribution/DistributionException.java
+++ b/commons-statistics-distribution/src/main/java/org/apache/commons/statistics/distribution/DistributionException.java
@@ -22,9 +22,9 @@ import java.util.Locale;
* Package private exception class with constants for frequently used messages.
*/
class DistributionException extends IllegalArgumentException {
- /** Error message for "too large" condition when "x > y". */
+ /** Error message for "too large" condition when {@code x > y}. */
static final String TOO_LARGE = "%s > %s";
- /** Error message for "too small" condition when "x < y". */
+ /** Error message for "too small" condition when {@code x < y}. */
static final String TOO_SMALL = "%s < %s";
/** Error message for "out of range" condition when "x not in [a, b]". */
static final String OUT_OF_RANGE = "Number %s is out of range [%s, %s]";
@@ -36,11 +36,11 @@ class DistributionException extends IllegalArgumentException {
static final String INVALID_PROBABILITY = "Not a probability: %s is out of range [0, 1]";
/** Error message for "invalid non-zero probability" condition when "x not in (0, 1]". */
static final String INVALID_NON_ZERO_PROBABILITY = "Not a non-zero probability: %s is out of range (0, 1]";
- /** Error message for "negative" condition when "x < 0". */
+ /** Error message for "negative" condition when {@code x < 0}. */
static final String NEGATIVE = "Number %s is negative";
- /** Error message for "not strictly positive" condition when "x <= 0". */
+ /** Error message for "not strictly positive" condition when {@code x <= 0}. */
static final String NOT_STRICTLY_POSITIVE = "Number %s is not greater than 0";
- /** Error message for "not strictly positive" condition when "x <= 0". */
+ /** Error message for "not strictly positive finite" condition when {@code x <= 0 || x == inf}. */
static final String NOT_STRICTLY_POSITIVE_FINITE = "Number %s is not greater than 0 and finite";
/** Serializable version identifier. */
diff --git a/commons-statistics-distribution/src/main/java/org/apache/commons/statistics/distribution/SaddlePointExpansionUtils.java b/commons-statistics-distribution/src/main/java/org/apache/commons/statistics/distribution/SaddlePointExpansionUtils.java
index 31ff62d..7a328c9 100644
--- a/commons-statistics-distribution/src/main/java/org/apache/commons/statistics/distribution/SaddlePointExpansionUtils.java
+++ b/commons-statistics-distribution/src/main/java/org/apache/commons/statistics/distribution/SaddlePointExpansionUtils.java
@@ -82,7 +82,6 @@ final class SaddlePointExpansionUtils {
* href="https://mathworld.wolfram.com/StirlingsSeries.html">
* https://mathworld.wolfram.com/StirlingsSeries.html</a></li>
* </ol>
- * </p>
*
* <p>Note: This function has been modified for integer {@code z}.</p>
*
@@ -112,7 +111,6 @@ final class SaddlePointExpansionUtils {
* href="http://www.herine.net/stat/papers/dbinom.pdf">
* http://www.herine.net/stat/papers/dbinom.pdf</a></li>
* </ol>
- * </p>
*
* <p>Note: This function has been modified for integer {@code x}.</p>
*