diff options
| author | Tom Smeding <tom@tomsmeding.com> | 2025-06-29 12:34:47 +0200 |
|---|---|---|
| committer | Tom Smeding <tom@tomsmeding.com> | 2025-06-29 12:40:01 +0200 |
| commit | 64404591661d3bc239804a1c17a25f81c434d852 (patch) | |
| tree | 52cce7c2d0cfd6086ca16e326456dad43d902049 /src/Data | |
| parent | 99a594767ae0bde6f836fcae55ff8abf87b5b300 (diff) | |
Improve Conversion haddocks
Diffstat (limited to 'src/Data')
| -rw-r--r-- | src/Data/Array/Nested/Convert.hs | 10 |
1 files changed, 7 insertions, 3 deletions
diff --git a/src/Data/Array/Nested/Convert.hs b/src/Data/Array/Nested/Convert.hs index de4a3e2..b68c8b0 100644 --- a/src/Data/Array/Nested/Convert.hs +++ b/src/Data/Array/Nested/Convert.hs @@ -101,14 +101,18 @@ shxFromShS (n :$$ sh) = SKnown n :$% shxFromShS sh -- * Array conversions -- | The constructors that perform runtime shape checking are marked with a --- @'@: 'ConvXS'' and 'ConvXX''. For the other constructors, the types ensure --- that the shapes are already compatible. To convert between 'Ranked' and --- 'Shaped', go via 'Mixed'. +-- tick (@'@): 'ConvXS'' and 'ConvXX''. For the other constructors, the types +-- ensure that the shapes are already compatible. To convert between 'Ranked' +-- and 'Shaped', go via 'Mixed'. -- -- 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'. +-- +-- /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 +-- readable presentation of this data type. data Conversion a b where ConvId :: Conversion a a ConvCmp :: Conversion b c -> Conversion a b -> Conversion a c |