From 8b8b095a2d7cc321b520b3d3dc707f3f0501d2e3 Mon Sep 17 00:00:00 2001 From: Jaro Date: Thu, 18 May 2023 18:55:01 +0200 Subject: [PATCH] Fix documentation: internal references. --- src/Data/Text/ParagraphLayout/Internal/Layout.hs | 4 ++-- src/Data/Text/ParagraphLayout/Internal/ParagraphLine.hs | 6 +++--- 2 files changed, 5 insertions(+), 5 deletions(-) diff --git a/src/Data/Text/ParagraphLayout/Internal/Layout.hs b/src/Data/Text/ParagraphLayout/Internal/Layout.hs index bf8f5c6..f8d50be 100644 --- a/src/Data/Text/ParagraphLayout/Internal/Layout.hs +++ b/src/Data/Text/ParagraphLayout/Internal/Layout.hs @@ -196,8 +196,8 @@ layoutAndWrapRunsH maxWidth prevOpenBoxes runs = NonEmpty.head $ validProtoLines -- shortest hard break. splits = hardSplit runs :| softSplits runs --- | Construct a `ProtoLine`, peeking at the text run on the following line --- to determine `nextOpenBoxes`. +-- | Construct a `PL.ProtoLine`, peeking at the text run on the following line +-- to determine `PL.nextOpenBoxes`. protoLine :: [RB.ResolvedBox d] -> [ProtoFragmentWithSpan d] diff --git a/src/Data/Text/ParagraphLayout/Internal/ParagraphLine.hs b/src/Data/Text/ParagraphLayout/Internal/ParagraphLine.hs index e0a3f79..4c0aff8 100644 --- a/src/Data/Text/ParagraphLayout/Internal/ParagraphLine.hs +++ b/src/Data/Text/ParagraphLayout/Internal/ParagraphLine.hs @@ -56,11 +56,11 @@ instance GenericLayout (R.ParagraphLayout d) where shiftFragments dy = R.mapFragments (shiftFragment dy) appendFragments = R.appendFragments --- | Split the given `ParagraphLayout` into single-line layouts. +-- | Split the given paragraph layout into single-line layouts. cutLines :: GenericLayout pl => pl -> [pl] cutLines pl = map (\ n -> cutLine n pl) (lineNumbers pl) --- | Reduce the given `ParagraphLayout` to fragments with the given line number. +-- | Reduce the given paragraph layout to fragments with the given line number. cutLine :: GenericLayout pl => Int -> pl -> pl cutLine n pl = trimTop $ limitFragments n pl @@ -78,7 +78,7 @@ uniqueFragmentLines frags = dedupe $ map fragmentLine frags dedupe :: Eq a => [a] -> [a] dedupe xs = map NonEmpty.head $ NonEmpty.group xs --- | Put the given `ParagraphLayout`s together as a vertically contiguous +-- | Put the given paragraph layouts together as a vertically contiguous -- sequence. mergeLines :: GenericLayout pl => [pl] -> pl mergeLines lls = foldl mergeLine empty lls -- 2.30.2