Use Godoc standard to mark deprecated Equals and StringScaled methods(#342)

This commit is contained in:
Feras AlSaffar 2024-01-15 22:50:05 +03:00 committed by GitHub
parent 7b4ffbcd3c
commit 142a0cf2f2
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23

View file

@ -986,7 +986,7 @@ func (d Decimal) Equal(d2 Decimal) bool {
return d.Cmp(d2) == 0 return d.Cmp(d2) == 0
} }
// Equals is deprecated, please use Equal method instead // Deprecated: Equals is deprecated, please use Equal method instead.
func (d Decimal) Equals(d2 Decimal) bool { func (d Decimal) Equals(d2 Decimal) bool {
return d.Equal(d2) return d.Equal(d2)
} }
@ -1559,7 +1559,8 @@ func (d *Decimal) GobDecode(data []byte) error {
} }
// StringScaled first scales the decimal then calls .String() on it. // StringScaled first scales the decimal then calls .String() on it.
// NOTE: buggy, unintuitive, and DEPRECATED! Use StringFixed instead. //
// Deprecated: buggy and unintuitive. Use StringFixed instead.
func (d Decimal) StringScaled(exp int32) string { func (d Decimal) StringScaled(exp int32) string {
return d.rescale(exp).String() return d.rescale(exp).String()
} }
@ -1698,8 +1699,7 @@ func unquoteIfQuoted(value interface{}) (string, error) {
case []byte: case []byte:
bytes = v bytes = v
default: default:
return "", fmt.Errorf("could not convert value '%+v' to byte array of type '%T'", return "", fmt.Errorf("could not convert value '%+v' to byte array of type '%T'", value, value)
value, value)
} }
// If the amount is quoted, strip the quotes // If the amount is quoted, strip the quotes