Suggest posLine . lengthAsPosition instead of lengthInLines

Bodigrim · Apr 25, 2022 · 1f721c1 · 1f721c1
1 parent 8939b8a
commit 1f721c1
Show file tree

Hide file tree

Showing 3 changed files with 9 additions and 0 deletions.
diff --git a/src/Data/Text/Rope.hs b/src/Data/Text/Rope.hs
@@ -248,6 +248,9 @@ lastChar = \case
 -- >>> lengthInLines "foo\nbar"
 -- 2
 --
+-- If you do not care about ignoring the last newline character,
+-- you can use 'posLine' . 'lengthAsPosition' instead, which works in O(1).
+--
 lengthInLines :: Rope -> Word
 lengthInLines rp = case lastChar rp of
   Nothing -> 0

diff --git a/src/Data/Text/Utf16/Rope.hs b/src/Data/Text/Utf16/Rope.hs
@@ -247,6 +247,9 @@ lastChar = \case
 -- >>> lengthInLines "foo\nbar"
 -- 2
 --
+-- If you do not care about ignoring the last newline character,
+-- you can use 'posLine' . 'lengthAsPosition' instead, which works in O(1).
+--
 lengthInLines :: Rope -> Word
 lengthInLines rp = case lastChar rp of
   Nothing -> 0

diff --git a/src/Data/Text/Utf16/Rope/Mixed.hs b/src/Data/Text/Utf16/Rope/Mixed.hs
@@ -285,6 +285,9 @@ lastChar = \case
 -- >>> lengthInLines "foo\nbar"
 -- 2
 --
+-- If you do not care about ignoring the last newline character,
+-- you can use 'Char.posLine' . 'charLengthAsPosition' instead, which works in O(1).
+--
 lengthInLines :: Rope -> Word
 lengthInLines rp = case lastChar rp of
   Nothing -> 0