From 4c98bed76fe726fa75cd5f99caf25140821a35a7 Mon Sep 17 00:00:00 2001
From: Andy Cheng <andy.cheng@richsoda.com>
Date: Thu, 15 Dec 2022 17:08:14 +0800
Subject: [PATCH] feature/dynamic_quantity: add comment for getQuantity()

---
 pkg/dynamicmetric/dynamic_quantity.go | 1 +
 1 file changed, 1 insertion(+)

diff --git a/pkg/dynamicmetric/dynamic_quantity.go b/pkg/dynamicmetric/dynamic_quantity.go
index fa3182ada..4fc222494 100644
--- a/pkg/dynamicmetric/dynamic_quantity.go
+++ b/pkg/dynamicmetric/dynamic_quantity.go
@@ -84,6 +84,7 @@ func (d *DynamicQuantityLinReg) initialize(symbol string, session *bbgo.Exchange
 }
 
 // getQuantity returns quantity
+// If reverse is true, the LinReg slope ratio is reversed, ie -0.01 becomes 0.01. This is for short orders.
 func (d *DynamicQuantityLinReg) getQuantity(reverse bool) (fixedpoint.Value, error) {
 	var linregRatio float64
 	if reverse {