From 1d24af13a8ddc4df0a132a80737ce2176cf4a1aa Mon Sep 17 00:00:00 2001
From: c9s <yoanlin93@gmail.com>
Date: Tue, 25 Jul 2023 17:50:48 +0800
Subject: [PATCH] core: document order store options

---
 pkg/core/orderstore.go | 16 ++++++++++++----
 1 file changed, 12 insertions(+), 4 deletions(-)

diff --git a/pkg/core/orderstore.go b/pkg/core/orderstore.go
index 3af1ab81e..b639e8ce1 100644
--- a/pkg/core/orderstore.go
+++ b/pkg/core/orderstore.go
@@ -11,11 +11,19 @@ type OrderStore struct {
 	mu     sync.Mutex
 	orders map[uint64]types.Order
 
-	Symbol          string
+	Symbol string
+
+	// RemoveCancelled removes the canceled order when receiving a cancel order update event
+	// It also removes the order even if it's partially filled
+	// by default, only 0 filled canceled order will be removed.
 	RemoveCancelled bool
-	RemoveFilled    bool
-	AddOrderUpdate  bool
-	C               chan types.Order
+
+	// RemoveFilled removes the fully filled order when receiving a filled order update event
+	RemoveFilled bool
+
+	// AddOrderUpdate adds the order into the store when receiving an order update when the order does not exist in the current store.
+	AddOrderUpdate bool
+	C              chan types.Order
 }
 
 func NewOrderStore(symbol string) *OrderStore {