Skip to content

Commit

Permalink
💡 chore: update some func and method comments
Browse files Browse the repository at this point in the history
  • Loading branch information
inhere committed Sep 8, 2023
1 parent e884faa commit b53b4e7
Show file tree
Hide file tree
Showing 3 changed files with 7 additions and 6 deletions.
5 changes: 3 additions & 2 deletions conv.go
Expand Up @@ -75,11 +75,12 @@ func BoolString(bl bool) string {

// BaseTypeVal convert custom type or intX,uintX,floatX to generic base type.
//
// intX/unitX => int64
// intX => int64
// unitX => uint64
// floatX => float64
// string => string
//
// returns int64,string,float or error
// returns int64,uint64,string,float or error
func BaseTypeVal(val any) (value any, err error) {
return reflects.BaseTypeVal(reflect.ValueOf(val))
}
Expand Down
2 changes: 1 addition & 1 deletion structs/alias.go
Expand Up @@ -52,7 +52,7 @@ func (as *Aliases) HasAlias(alias string) bool {
return false
}

// ResolveAlias by given name.
// ResolveAlias by given name. if not exists, return the alias self
func (as *Aliases) ResolveAlias(alias string) string {
if name, ok := as.mapping[alias]; ok {
return name
Expand Down
6 changes: 3 additions & 3 deletions strutil/strutil.go
Expand Up @@ -21,7 +21,7 @@ func OrCond(cond bool, s1, s2 string) string {
return s2
}

// BlankOr return default value on val is blank, else return val
// BlankOr return default value on val is blank, otherwise return val
func BlankOr(val, defVal string) string {
val = strings.TrimSpace(val)
if val != "" {
Expand All @@ -30,15 +30,15 @@ func BlankOr(val, defVal string) string {
return defVal
}

// ZeroOr return default value on val is zero, else return val. same of OrElse()
// ZeroOr return default value on val is zero, otherwise return val. same of OrElse()
func ZeroOr[T ~string](val, defVal T) T {
if val != "" {
return val
}
return defVal
}

// OrElse return default value on val is zero, else return s
// OrElse return default value on s is empty, otherwise return s
func OrElse(s, orVal string) string {
if s != "" {
return s
Expand Down

0 comments on commit b53b4e7

Please sign in to comment.