Repackage test to add Examples

slice/remove_test.go

@@ -1,11 +1,30 @@
-package slice
+package slice_test
 
 import (
+	"fmt"
 	"testing"
 
+	"github.com/mailgun/holster/v4/slice"
 	"github.com/stretchr/testify/assert"
 )
 
+func ExampleRemove() {
+	s := []string{"1", "2", "3"}
+	i := []int{1, 2, 3}
+
+	fmt.Println(slice.Remove(s, 0, 2))
+	fmt.Println(slice.Remove(i, 1, 2))
+	// Output:
+	// [3]
+	// [1 3]
+}
+
+func ExampleRemoveAll() {
+	s := []int{1, 2, 3, 2, 4, 2}
+	fmt.Println(slice.RemoveAll(s, 2))
+	// Output: [1 3 4]
+}
+
 func TestRemove(t *testing.T) {
 	for _, test := range []struct {
 		name     string
@@ -55,7 +74,7 @@ func TestRemove(t *testing.T) {
 		outSlice: nil,
 	}, {}} {
 		t.Run(test.name, func(t *testing.T) {
-			got := Remove(test.inSlice, test.i, test.j)
+			got := slice.Remove(test.inSlice, test.i, test.j)
 			for i, expected := range test.outSlice {
 				assert.Equal(t, expected, got[i])
 			}
@@ -111,7 +130,7 @@ func TestRemoveAll(t *testing.T) {
 		outSlice: []string{"foo", "bar", "baz.com"},
 	}} {
 		t.Run(test.name, func(t *testing.T) {
-			out := RemoveAll(test.inSlice, test.remove)
+			out := slice.RemoveAll(test.inSlice, test.remove)
 			for i, expected := range test.outSlice {
 				assert.Equal(t, expected, out[i])
 			}
@@ -127,7 +146,7 @@ func BenchmarkRemove(b *testing.B) {
 
 	b.ResetTimer()
 	for i := 0; i < b.N; i++ {
-		o = Remove(in, 2, 4)
+		o = slice.Remove(in, 2, 4)
 	}
 	out = o
 }
@@ -138,7 +157,7 @@ func BenchmarkRemoveAll(b *testing.B) {
 
 	b.ResetTimer()
 	for i := 0; i < b.N; i++ {
-		o = RemoveAll(in, "localhost")
+		o = slice.RemoveAll(in, "localhost")
 	}
 	out = o
 }