diff options
| author | Tom Smeding <tom@tomsmeding.com> | 2024-04-17 12:19:18 +0200 |
|---|---|---|
| committer | Tom Smeding <tom@tomsmeding.com> | 2024-04-17 12:19:18 +0200 |
| commit | 1496e0262e63edc9b004d53a917efef9e9c2dca7 (patch) | |
| tree | 0a44570d29247ec40be8ea834f0707afbb85fbfc /src/Data/Array | |
| parent | 4fa4f193bdba187deb7ead0ff839c78c25125c7b (diff) | |
Fix haddocks formatting
Diffstat (limited to 'src/Data/Array')
| -rw-r--r-- | src/Data/Array/Nested/Internal.hs | 14 |
1 files changed, 7 insertions, 7 deletions
diff --git a/src/Data/Array/Nested/Internal.hs b/src/Data/Array/Nested/Internal.hs index b0c0e56..f769870 100644 --- a/src/Data/Array/Nested/Internal.hs +++ b/src/Data/Array/Nested/Internal.hs @@ -377,14 +377,14 @@ checkBounds (_ ::? sh') (() :$? ssh') = checkBounds sh' ssh' -- | Create an array given a size and a function that computes the element at a -- given index. -- --- **WARNING**: It is required that every @a@ returned by the argument to +-- __WARNING__: It is required that every @a@ returned by the argument to -- 'mgenerate' has the same shape. For example, the following will throw a -- runtime error: -- --- foo :: Mixed [Nothing] (Mixed [Nothing] Double) --- foo = mgenerate (10 ::: IZR) $ \(i ::: IZR) -> --- mgenerate (i ::: IZR) $ \(j ::: IZR) -> --- ... +-- > foo :: Mixed [Nothing] (Mixed [Nothing] Double) +-- > foo = mgenerate (10 ::: IZR) $ \(i ::: IZR) -> +-- > mgenerate (i ::: IZR) $ \(j ::: IZR) -> +-- > ... -- -- because the size of the inner 'mgenerate' is not always the same (it depends -- on @i@). Nested arrays in @ox-arrays@ are always stored fully flattened, so @@ -817,7 +817,7 @@ rindexPartial (Ranked arr) idx = (rewriteMixed (lemReplicatePlusApp (Proxy @n) (Proxy @m) (Proxy @Nothing)) arr) (ixCvtRX idx)) --- | **WARNING**: All values returned from the function must have equal shape. +-- | __WARNING__: All values returned from the function must have equal shape. -- See the documentation of 'mgenerate' for more details. rgenerate :: forall n a. Elt a => IxR n -> (IxR n -> a) -> Ranked n a rgenerate sh f @@ -943,7 +943,7 @@ sindexPartial (Shaped arr) idx = (rewriteMixed (lemMapJustPlusApp (Proxy @sh1) (Proxy @sh2)) arr) (ixCvtSX idx)) --- | **WARNING**: All values returned from the function must have equal shape. +-- | __WARNING__: All values returned from the function must have equal shape. -- See the documentation of 'mgenerate' for more details. sgenerate :: forall sh a. (KnownShape sh, Elt a) => (IxS sh -> a) -> Shaped sh a sgenerate f |