summaryrefslogtreecommitdiff
path: root/libraries/base/Data
diff options
context:
space:
mode:
authorARJANEN Loïc Jean David <arjanen.loic@gmail.com>2018-06-17 11:30:28 -0400
committerBen Gamari <ben@smart-cactus.org>2018-06-17 12:41:42 -0400
commit793902e6891c30150fd3ac1e0e471269a4766780 (patch)
tree495e1964f6b30cab0dff45c9f69bd3ed703ca811 /libraries/base/Data
parentdf0f148feae4c3b9653260edff843d561d6d5918 (diff)
downloadhaskell-793902e6891c30150fd3ac1e0e471269a4766780.tar.gz
Improve documentation of Eq, Ord instances for Float and Double
Reviewers: sjakobi, dfeuer, bgamari, hvr Reviewed By: sjakobi, bgamari Subscribers: rwbarton, thomie, carter GHC Trac Issues: #15078 Differential Revision: https://phabricator.haskell.org/D4736
Diffstat (limited to 'libraries/base/Data')
-rw-r--r--libraries/base/Data/Complex.hs4
1 files changed, 4 insertions, 0 deletions
diff --git a/libraries/base/Data/Complex.hs b/libraries/base/Data/Complex.hs
index 073f5c5e86..a544a5bf6c 100644
--- a/libraries/base/Data/Complex.hs
+++ b/libraries/base/Data/Complex.hs
@@ -55,6 +55,10 @@ infix 6 :+
-- has the phase of @z@, but unit magnitude.
--
-- The 'Foldable' and 'Traversable' instances traverse the real part first.
+--
+-- Note that `Complex`'s instances inherit the deficiencies from the type
+-- parameter's. For example, @Complex Float@'s 'Ord' instance has similar
+-- problems to `Float`'s.
data Complex a
= !a :+ !a -- ^ forms a complex number from its real and imaginary
-- rectangular components.