pkg/eval/vals: Correct the godoc of Cmp.

This commit is contained in:
Qi Xiao 2023-05-20 10:20:48 +01:00
parent c71995ba9a
commit 7c0c3eb82d

View File

@ -18,7 +18,8 @@ const (
)
// Cmp compares two Elvish values and returns the ordering relationship between
// them. Cmp(a, b) returns CmpEqual iff Equal(a, b) returns true.
// them. Cmp(a, b) returns CmpEqual iff Equal(a, b) is true or both a and b are
// NaNs.
func Cmp(a, b any) Ordering {
return cmpInner(a, b, Cmp)
}