Merge pull request #50 from jplatte/master

Update nub / nubBy documentation and unit test to consider element order
purescript · Sep 16, 2015 · 651ffc7 · 651ffc7
2 parents a19f127 + efd571b
commit 651ffc7
Show file tree

Hide file tree

Showing 2 changed files with 5 additions and 4 deletions.
diff --git a/docs/Data/Array.md b/docs/Data/Array.md
@@ -453,14 +453,17 @@ specified equivalence relation to detemine equality.
 nub :: forall a. (Eq a) => Array a -> Array a
 ```
 
+Special case of `nubBy`: `nubBy eq`
+
 #### `nubBy`
 
 ``` purescript
 nubBy :: forall a. (a -> a -> Boolean) -> Array a -> Array a
 ```
 
 Remove the duplicates from an array, where element equality is determined
-by the specified equivalence relation, creating a new array.
+by the specified equivalence relation, creating a new array. The first
+occurence of an element is always the one that is kept.
 
 #### `union`
 
@@ -566,5 +569,3 @@ second components.
 ``` purescript
 foldM :: forall m a b. (Monad m) => (a -> b -> m a) -> a -> Array b -> m a
 ```
-
-
diff --git a/test/Test/Data/Array.purs b/test/Test/Data/Array.purs
@@ -233,7 +233,7 @@ testArray = do
   log "groupBy should group consecutive equal elements into arrays based on an equivalence relation"
   assert $ groupBy (\x y -> odd x && odd y) [1, 1, 2, 2, 3, 3] == [[1, 1], [2], [2], [3, 3]]
 
-  log "nub should remove duplicate items from the list"
+  log "nub should remove duplicate elements from the list, keeping the first occurence"
   assert $ nub [1, 2, 2, 3, 4, 1] == [1, 2, 3, 4]
 
   log "nubBy should remove duplicate items from the list using a supplied predicate"