Skip to content

Commit 2c19b7b

Browse files
committed
Last few review notes on complex.
1 parent 2213879 commit 2c19b7b

File tree

2 files changed

+5
-8
lines changed

2 files changed

+5
-8
lines changed

Sources/ComplexModule/Documentation.docc/Complex.md

Lines changed: 3 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,9 @@
11
# ``Complex``
22

3-
A Complex number type that conforms to `AlgebraicField`
4-
(so all the normal arithmetic operations are available) and
5-
`ElementaryFunctions` (so all the usual math functions are
6-
available).
3+
A complex number type represented by its real and imaginary parts, and equipped
4+
with the usual arithmetic operators and math functions.
75

8-
A `Complex` value is represented with two `RealType` values, corresponding to
9-
the real and imaginary parts of the number.
6+
## Overview
107

118
You can access these Cartesian components using the real and imaginary
129
properties.

Sources/ComplexModule/Scale.swift

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -22,15 +22,15 @@
2222
// Complex! Obviously, that doesn't help anyone.
2323

2424
extension Complex {
25-
/// `self` multiplied by the real value `a`.
25+
/// The result of multiplying this value by the real number `a`.
2626
///
2727
/// Equivalent to `self * Complex(a)`, but may be computed more efficiently.
2828
@inlinable @inline(__always)
2929
public func multiplied(by a: RealType) -> Complex {
3030
Complex(x*a, y*a)
3131
}
3232

33-
/// `self` divided by the real value `a`.
33+
/// The result of dividing this value by the real number `a`.
3434
///
3535
/// More efficient than `self / Complex(a)`. May not produce exactly the
3636
/// same result, but will always be more accurate if they differ.

0 commit comments

Comments
 (0)