Update comments for indexparamcheck/utils.go (#8437)

Signed-off-by: yudong.cai <yudong.cai@zilliz.com>
This commit is contained in:
Cai Yudong 2021-09-24 09:41:54 +08:00 committed by GitHub
parent 98c423480e
commit 74d5bb3eef
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23

View File

@ -6,9 +6,12 @@ import (
"github.com/milvus-io/milvus/internal/util/funcutil"
)
// Check whether the data corresponding to the key is within the range of [min, max].
// If the key does not exist, or the data cannot be converted to an int type number, or the number is not in the range [min, max], return false
// Otherwise, return true
// CheckIntByRange check if the data corresponding to the key is in the range of [min, max].
// Return false if:
// 1. the key does not exist, or
// 2. the data cannot be converted to an integer, or
// 3. the number is not in the range [min, max]
// Return true otherwise
func CheckIntByRange(params map[string]string, key string, min, max int) bool {
valueStr, ok := params[key]
if !ok {
@ -23,9 +26,11 @@ func CheckIntByRange(params map[string]string, key string, min, max int) bool {
return value >= min && value <= max
}
// Check whether the data corresponding to the key appears in the string slice of container.
// If the key does not exist, or the data does not appear in the container, return false
// Otherwise return true
// CheckStrByValues check whether the data corresponding to the key appears in the string slice of container.
// Return false if:
// 1. the key does not exist, or
// 2. the data does not appear in the container
// Return true otherwise
func CheckStrByValues(params map[string]string, key string, container []string) bool {
value, ok := params[key]
if !ok {