aboutsummaryrefslogtreecommitdiff
path: root/src/Data/Array
diff options
context:
space:
mode:
authorMikolaj Konarski <mikolaj.konarski@funktory.com>2026-04-11 22:45:13 +0200
committerMikolaj Konarski <mikolaj.konarski@funktory.com>2026-04-11 22:45:13 +0200
commitb11c22ff51e00478b2e381c677b9fb09477379dd (patch)
tree695f1685da320cca3fcdde1a45a9c9b9617d6277 /src/Data/Array
parent1a0324d8c7ce40c0c0c4a09d1f143d36b21575ae (diff)
Fix some haddock errors
Diffstat (limited to 'src/Data/Array')
-rw-r--r--src/Data/Array/Nested/Convert.hs5
-rw-r--r--src/Data/Array/Nested/Mixed.hs9
-rw-r--r--src/Data/Array/Nested/Shaped/Base.hs3
3 files changed, 10 insertions, 7 deletions
diff --git a/src/Data/Array/Nested/Convert.hs b/src/Data/Array/Nested/Convert.hs
index c6f23ae..7619bdb 100644
--- a/src/Data/Array/Nested/Convert.hs
+++ b/src/Data/Array/Nested/Convert.hs
@@ -177,8 +177,9 @@ shxFromShS = coerce
--
-- The guiding principle behind 'Conversion' is that it should represent the
-- array restructurings, or perhaps re-presentations, that do not change the
--- underlying 'XArray's. This leads to the inclusion of some operations that do
--- not look like simple conversions (casts) at first glance, like 'ConvZip'.
+-- underlying 'Data.Array.XArray.XArray's. This leads to the inclusion
+-- of some operations that do not look like simple conversions (casts)
+-- at first glance, like 'ConvZip'.
--
-- /Note/: Haddock gleefully renames type variables in constructors so that
-- they match the data type head as much as possible. See the source for a more
diff --git a/src/Data/Array/Nested/Mixed.hs b/src/Data/Array/Nested/Mixed.hs
index b036203..7371c4b 100644
--- a/src/Data/Array/Nested/Mixed.hs
+++ b/src/Data/Array/Nested/Mixed.hs
@@ -301,9 +301,10 @@ mremArray = mliftNumElt2 (liftO2 . intEltRem)
matan2Array :: (FloatElt a, PrimElt a) => Mixed sh a -> Mixed sh a -> Mixed sh a
matan2Array = mliftNumElt2 (liftO2 . floatEltAtan2)
--- | Allowable element types in a mixed array, and by extension in a 'Ranked' or
--- 'Shaped' array. Note the polymorphic instance for 'Elt' of @'Primitive'
--- a@; see the documentation for 'Primitive' for more details.
+-- | Allowable element types in a mixed array, and by extension
+-- in a 'Data.Array.Nested.Ranked.Ranked' or 'Data.Array.Nested.Shaped.Shaped'
+-- array. Note the polymorphic instance for 'Elt' of @'Primitive' a@;
+-- see the documentation for 'Primitive' for more details.
class Elt a where
-- ====== PUBLIC METHODS ====== --
@@ -313,7 +314,7 @@ class Elt a where
mscalar :: a -> Mixed '[] a
-- | See 'mfromListOuter'. If the list does not have the given length, a
- -- runtime error is thrown. 'mfromListPrimSN' is faster if applicable.
+ -- runtime error is thrown.
mfromListOuterSN :: forall sh n. SNat n -> NonEmpty (Mixed sh a) -> Mixed (Just n : sh) a
mtoListOuter :: Mixed (n : sh) a -> [Mixed sh a]
diff --git a/src/Data/Array/Nested/Shaped/Base.hs b/src/Data/Array/Nested/Shaped/Base.hs
index 4b119c4..a5e6247 100644
--- a/src/Data/Array/Nested/Shaped/Base.hs
+++ b/src/Data/Array/Nested/Shaped/Base.hs
@@ -45,7 +45,8 @@ import Data.Array.XArray (XArray)
-- these are "GHC.TypeLits" naturals, because we do not need induction over
-- them and we want very large arrays to be possible.
--
--- Like for 'Ranked', the valid elements are described by the 'Elt' type class,
+-- Like for 'Data.Array.Nested.Ranked.Base.Ranked',
+-- the valid elements are described by the 'Elt' type class,
-- and 'Shaped' itself is again an instance of 'Elt' as well.
--
-- 'Shaped' is a newtype around a 'Mixed' of 'Just's.