String.split: Improve documentation

- Add more examples
- Fix typo

Author: gasi

CHANGELOG.md

@@ -12,6 +12,10 @@ Bugfixes:
 
 Other improvements:
 
+- `split` (#165)
+  - Add more examples.
+  - Fix typo in documentation.
+
 ## [v6.0.1](https://github.com/purescript/purescript-strings/releases/tag/v6.0.1) - 2022-08-16
 
 Bugfixes:

src/Data/String/Common.purs

@@ -56,11 +56,18 @@ foreign import replace :: Pattern -> Replacement -> String -> String
 -- | ```
 foreign import replaceAll :: Pattern -> Replacement -> String -> String
 
--- | Returns the substrings of the second string separated along occurences
+-- | Returns the substrings of the second string separated along occurrences
 -- | of the first string.
 -- |
 -- | ```purescript
+-- | -- single match
 -- | split (Pattern " ") "hello world" == ["hello", "world"]
+-- | -- multiple matches
+-- | split (Pattern " | ") "foo | bar | baz" == ["foo", "bar", "baz"]
+-- | -- no match
+-- | split (Pattern "baz") "foo bar" == ["foo bar"]
+-- | -- empty string
+-- | split (Pattern "") "foo bar" == ["f","o","o"," ","b","a","r"]
 -- | ```
 foreign import split :: Pattern -> String -> Array String
 

test/Test/Data/String.purs

@@ -99,6 +99,10 @@ testString = do
     { actual: S.split (Pattern "d") "abc"
     , expected: ["abc"]
     }
+  assertEqual
+    { actual: S.split (Pattern "--") "a--b--c"
+    , expected: ["a", "b", "c"]
+    }
 
   log "toLower"
   assertEqual