aboutsummaryrefslogtreecommitdiff
path: root/src
diff options
context:
space:
mode:
authorTom Smeding <tom@tomsmeding.com>2025-12-06 11:18:51 +0100
committerTom Smeding <tom@tomsmeding.com>2025-12-06 11:18:51 +0100
commitd1e2e280644baece2cabb075d566d99cc2c27019 (patch)
treea0b57993e9e68cb453680c4a85d8d74c9714c132 /src
parentde92940e793ddd6f53837de80ff316398d3e1809 (diff)
XArray: Fix doc comment on ravelOuterNHEADmaster
Diffstat (limited to 'src')
-rw-r--r--src/Data/Array/XArray.hs5
1 files changed, 2 insertions, 3 deletions
diff --git a/src/Data/Array/XArray.hs b/src/Data/Array/XArray.hs
index 64bbb0c..6389e67 100644
--- a/src/Data/Array/XArray.hs
+++ b/src/Data/Array/XArray.hs
@@ -324,9 +324,8 @@ fromListOuter ssh l
let n = length l
in XArray (ravelOuterN n l')
--- This checks that the list has the given length and that each shape
--- on the list equals the given shape. The list is streamed.
--- The list can't be empty.
+-- | This checks that the list has the given length and that all shapes in the
+-- list are equal. The list must be non-empty, and is streamed.
ravelOuterN :: (KnownNat k, Storable a)
=> Int -> [S.Array k a] -> S.Array (1 + k) a
ravelOuterN 0 _ = error "ravelOuterN: N == 0"