Changed lume.clear() to return the table, updated doc & tests

README.md

@@ -91,7 +91,8 @@ lume.remove(t, 2) -- `t` becomes { 1, 3 }
 ```
 
 ### lume.clear(t)
-Nils all the values in the table `t`, this renders the table empty.
+Nils all the values in the table `t`, this renders the table empty. Returns
+`t`.
 ```lua
 local t = { 1, 2, 3 }
 lume.clear(t) -- `t` becomes {}

lume.lua

@@ -180,6 +180,7 @@ function lume.clear(t)
   for k, v in iter(t) do
     t[k] = nil
   end
+  return t
 end
 
 

test/test_lume.lua

@@ -142,6 +142,7 @@ tests["lume.clear"] = function()
   local m = { a = 1, b = 2, c = 3 }
   lume.clear(m)
   testeq(m, {})
+  testeq( lume.clear(t) == t, true )
 end
 
 -- lume.shuffle