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 2020/04/09 09:25:55 UTC

[commons-numbers] 01/04: BigFraction: Document exception thrown by reciprocal when zero.

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-numbers.git

commit c8e4fe25bbdb08ecb23643bde3f3ac55d0926156
Author: aherbert <ah...@apache.org>
AuthorDate: Thu Apr 9 09:46:20 2020 +0100

    BigFraction: Document exception thrown by reciprocal when zero.
---
 .../main/java/org/apache/commons/numbers/fraction/BigFraction.java | 7 +++++++
 1 file changed, 7 insertions(+)

diff --git a/commons-numbers-fraction/src/main/java/org/apache/commons/numbers/fraction/BigFraction.java b/commons-numbers-fraction/src/main/java/org/apache/commons/numbers/fraction/BigFraction.java
index d0411f0..541fb6c 100644
--- a/commons-numbers-fraction/src/main/java/org/apache/commons/numbers/fraction/BigFraction.java
+++ b/commons-numbers-fraction/src/main/java/org/apache/commons/numbers/fraction/BigFraction.java
@@ -521,6 +521,13 @@ public final class BigFraction
         return new BigFraction(numerator.negate(), denominator);
     }
 
+    /**
+     * {@inheritDoc}
+     *
+     * <p>Raises an exception if the fraction is equal to zero.
+     *
+     * @throws ArithmeticException if the current numerator is {@code zero}
+     */
     @Override
     public BigFraction reciprocal() {
         return new BigFraction(denominator, numerator);