Add comment to order.Side.UnmarshalJSON

gbjk · Sep 11, 2023 · 27d369f · 27d369f
1 parent da419f8
commit 27d369f
Showing 1 changed file with 2 additions and 0 deletions.
diff --git a/exchanges/order/orders.go b/exchanges/order/orders.go
@@ -1063,6 +1063,8 @@ func StringToOrderSide(side string) (Side, error) {
 	}
 }
 
+// UnmarshalJSON parses the JSON-encoded order side and stores the result
+// It expects a quoted string input, and uses StringToOrderSide to parse it
 func (s *Side) UnmarshalJSON(data []byte) (err error) {
 	if !bytes.HasPrefix(data, []byte(`"`)) {
 		// Note that we don't need to worry about invalid JSON here, it wouldn't have made it past the deserialiser far