From bc12e885019717175199896ef4384af590e59241 Mon Sep 17 00:00:00 2001 From: c9s Date: Tue, 2 Jul 2024 14:47:36 +0800 Subject: [PATCH] add func doc comments --- pkg/types/price_volume_slice.go | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/pkg/types/price_volume_slice.go b/pkg/types/price_volume_slice.go index 0e3821612..5ca022dbb 100644 --- a/pkg/types/price_volume_slice.go +++ b/pkg/types/price_volume_slice.go @@ -181,6 +181,8 @@ func (slice *PriceVolumeSlice) UnmarshalJSON(b []byte) error { return nil } +// ParsePriceVolumeKvSliceJSON parses a JSON array of objects into PriceVolumeSlice +// [{"Price":...,"Volume":...}, ...] func ParsePriceVolumeKvSliceJSON(b []byte) (PriceVolumeSlice, error) { type S PriceVolumeSlice var ts S @@ -200,6 +202,8 @@ func ParsePriceVolumeKvSliceJSON(b []byte) (PriceVolumeSlice, error) { // ParsePriceVolumeSliceJSON tries to parse a 2 dimensional string array into a PriceVolumeSlice // // [["9000", "10"], ["9900", "10"], ... ] +// +// if parse failed, then it will try to parse the JSON array of objects, function ParsePriceVolumeKvSliceJSON will be called. func ParsePriceVolumeSliceJSON(b []byte) (slice PriceVolumeSlice, err error) { var as [][]fixedpoint.Value