Add doc tests for splitEndBySeq and splitEndBySeq_

composewell · Jan 2, 2025 · e7916c4 · e7916c4
1 parent 4d1373b
commit e7916c4
Show file tree

Hide file tree

Showing 2 changed files with 105 additions and 1 deletion.
diff --git a/core/src/Streamly/Internal/Data/Stream/Nesting.hs b/core/src/Streamly/Internal/Data/Stream/Nesting.hs
@@ -3601,6 +3601,58 @@ splitOnSuffixSeq withSep patArr (Fold fstep initial _ final) (Stream step state)
 --
 -- >>> splitEndBySeq pat f = Stream.foldMany (Fold.takeEndBySeq pat f)
 --
+-- Usage:
+--
+-- >>> splitOnSuffix p xs = Stream.fold Fold.toList $ Stream.splitEndBySeq (Array.fromList p) Fold.toList (Stream.fromList xs)
+--
+-- >>> splitOnSuffix "" ""
+-- []
+--
+-- >>> splitOnSuffix "." ""
+-- []
+--
+-- >>> splitOnSuffix ".." ""
+-- []
+--
+-- >>> splitOnSuffix "..." ""
+-- []
+--
+-- >>> splitOnSuffix "" "a...b"
+-- ["a",".",".',".","b"]
+--
+-- >>> splitOnSuffix "." "a...b"
+-- ["a.",".",".","b"]
+--
+-- >>> splitOnSuffix ".." "a...b"
+-- ["a..",".b"]
+--
+-- >>> splitOnSuffix "..." "a...b"
+-- ["a...","b"]
+--
+-- >>> splitOnSuffix "." "abc"
+-- ["abc"]
+--
+-- >>> splitOnSuffix ".." "abc"
+-- ["abc"]
+--
+-- >>> splitOnSuffix "..." "abc"
+-- ["abc"]
+--
+-- >>> splitOnSuffix "." "."
+-- ["."]
+--
+-- >>> splitOnSuffix ".." ".."
+-- [".."]
+--
+-- >>> splitOnSuffix "..." "..."
+-- ["..."]
+--
+-- >>> splitOnSuffix "." ".a"
+-- [".","a"]
+--
+-- >>> splitOnSuffix "." "a."
+-- ["a."]
+--
 -- Uses Rabin-Karp algorithm for substring search.
 --
 {-# INLINE_NORMAL splitEndBySeq #-}
@@ -3618,6 +3670,58 @@ splitEndBySeq = splitOnSuffixSeq True
 --
 -- >>> splitEndBySeq_ pat f = Stream.foldMany (Fold.takeEndBySeq_ pat f)
 --
+-- Usage:
+--
+-- >>> splitOnSuffix p xs = Stream.fold Fold.toList $ Stream.splitEndBySeq_ (Array.fromList p) Fold.toList (Stream.fromList xs)
+--
+-- >>> splitOnSuffix "" ""
+-- []
+--
+-- >>> splitOnSuffix "." ""
+-- []
+--
+-- >>> splitOnSuffix ".." ""
+-- []
+--
+-- >>> splitOnSuffix "..." ""
+-- []
+--
+-- >>> splitOnSuffix "" "a...b"
+-- ["a",".",".',".","b"]
+--
+-- >>> splitOnSuffix "." "a...b"
+-- ["a","","","b"]
+--
+-- >>> splitOnSuffix ".." "a...b"
+-- ["a",".b"]
+--
+-- >>> splitOnSuffix "..." "a...b"
+-- ["a","b"]
+--
+-- >>> splitOnSuffix "." "abc"
+-- ["abc"]
+--
+-- >>> splitOnSuffix ".." "abc"
+-- ["abc"]
+--
+-- >>> splitOnSuffix "..." "abc"
+-- ["abc"]
+--
+-- >>> splitOnSuffix "." "."
+-- [""]
+--
+-- >>> splitOnSuffix ".." ".."
+-- [""]
+--
+-- >>> splitOnSuffix "..." "..."
+-- [""]
+--
+-- >>> splitOnSuffix "." ".a"
+-- ["","a"]
+--
+-- >>> splitOnSuffix "." "a."
+-- ["a"]
+--
 -- Uses Rabin-Karp algorithm for substring search.
 --
 {-# INLINE_NORMAL splitEndBySeq_ #-}

diff --git a/core/streamly-core.cabal b/core/streamly-core.cabal
@@ -457,7 +457,7 @@ library
 
     -- Only those modules should be here which are fully re-exported via some
     -- other module.
-    other-modules:
+    exposed-modules:
                       Streamly.Internal.Data.Fold.Step
                     , Streamly.Internal.Data.Fold.Type
                     , Streamly.Internal.Data.Fold.Combinators