add comment when function-user sets chunkSize is less than 1

moneyforward · Feb 19, 2023 · c5e1716 · c5e1716
1 parent 6bdf150
commit c5e1716
Showing 1 changed file with 1 addition and 0 deletions.
diff --git a/app/pkg/slice/string.go b/app/pkg/slice/string.go
@@ -31,6 +31,7 @@ func ToStringSet(s []string) []string {
 }
 
 // SplitStringSliceInChunks SplitStringSliceInChunk split slice in chunk
+// if you set chunkSize is less than 1, this function returns a 2 dimensional slice with 1 chunk ([][]string{s}).
 // TODO: Update 1.18+ and use generics
 func SplitStringSliceInChunks(s []string, chunkSize int) (chunks [][]string) {
 	if chunkSize < 1 {