From 0ace0c79acbd98b7592d155c8b54e2959e3a706f Mon Sep 17 00:00:00 2001
From: Mikolaj Konarski <mikolaj.konarski@funktory.com>
Date: Thu, 26 Jun 2025 23:50:19 +0200
Subject: Tweak haddocs and comments slightly

---
 src/Data/Array/Nested/Shaped/Shape.hs | 10 +++++++---
 1 file changed, 7 insertions(+), 3 deletions(-)

(limited to 'src/Data/Array/Nested/Shaped/Shape.hs')

diff --git a/src/Data/Array/Nested/Shaped/Shape.hs b/src/Data/Array/Nested/Shaped/Shape.hs
index fbfc7f5..20a7a7a 100644
--- a/src/Data/Array/Nested/Shaped/Shape.hs
+++ b/src/Data/Array/Nested/Shaped/Shape.hs
@@ -48,6 +48,8 @@ import Data.Array.Nested.Permutation
 import Data.Array.Nested.Types
 
 
+-- * Shaped lists
+
 type role ListS nominal representational
 type ListS :: [Nat] -> (Nat -> Type) -> Type
 data ListS sh f where
@@ -180,11 +182,9 @@ listsIndex _ _ _ ZS = error "Index into empty shape"
 listsPermutePrefix :: forall f is sh. Perm is -> ListS sh f -> ListS (PermutePrefix is sh) f
 listsPermutePrefix perm sh = listsAppend (listsPermute perm (listsTakeLenPerm perm sh)) (listsDropLenPerm perm sh)
 
+-- * Shaped indices
 
 -- | An index into a shape-typed array.
---
--- For convenience, this contains regular 'Int's instead of bounded integers
--- (traditionally called \"@Fin@\").
 type role IxS nominal representational
 type IxS :: [Nat] -> Type -> Type
 newtype IxS sh i = IxS (ListS sh (Const i))
@@ -203,6 +203,8 @@ infixr 3 :.$
 
 {-# COMPLETE ZIS, (:.$) #-}
 
+-- For convenience, this contains regular 'Int's instead of bounded integers
+-- (traditionally called \"@Fin@\").
 type IIxS sh = IxS sh Int
 
 #ifdef OXAR_DEFAULT_SHOW_INSTANCES
@@ -257,6 +259,8 @@ ixsPermutePrefix :: forall i is sh. Perm is -> IxS sh i -> IxS (PermutePrefix is
 ixsPermutePrefix = coerce (listsPermutePrefix @(Const i))
 
 
+-- * Shaped shapes
+
 -- | The shape of a shape-typed array given as a list of 'SNat' values.
 --
 -- Note that because the shape of a shape-typed array is known statically, you
-- 
cgit v1.2.3-70-g09d2