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 08f178096ac6595498c81eb768737cfec0dfae8e
Author: Alex Herbert <aherb...@apache.org>
AuthorDate: Wed Oct 20 22:14:24 2021 +0100
Correct first sentence of class javadoc
---
.../src/main/java/org/apache/commons/numbers/complex/Complex.java | 7 +++++--
1 file changed, 5 insertions(+), 2 deletions(-)
diff --git
a/commons-numbers-complex/src/main/java/org/apache/commons/numbers/complex/Complex.java
b/commons-numbers-complex/src/main/java/org/apache/commons/numbers/complex/Complex.java
index 2c9072b..4f1a4be 100644
---
a/commons-numbers-complex/src/main/java/org/apache/commons/numbers/complex/Complex.java
+++
b/commons-numbers-complex/src/main/java/org/apache/commons/numbers/complex/Complex.java
@@ -23,8 +23,11 @@ import java.util.List;
import java.util.function.DoubleUnaryOperator;
/**
- * Cartesian representation of a complex number, i.e. a number which has both a
- * real and imaginary part.
+ * Cartesian representation of a complex number. The complex number is
expressed
+ * in the form \( a + ib \) where \( a \) and \( b \) are real numbers and \(
i \)
+ * is the imaginary unit which satisfies the equation \( i^2 = -1 \). For the
+ * complex number \( a + ib \), \( a \) is called the <em>real part</em> and
+ * \( b \) is called the <em>imaginary part</em>.
*
* <p>This class is immutable. All arithmetic will create a new instance for
the
* result.</p>
