update command doc files

c9s · Jun 8, 2022 · c76d57e · c76d57e
1 parent 60af0b0
commit c76d57e
Show file tree

Hide file tree

Showing 2 changed files with 7 additions and 3 deletions.
diff --git a/doc/commands/bbgo.md b/doc/commands/bbgo.md
@@ -47,7 +47,7 @@ bbgo [flags]
 * [bbgo optimize](bbgo_optimize.md)	 - run optimizer
 * [bbgo orderbook](bbgo_orderbook.md)	 - connect to the order book market data streaming service of an exchange
 * [bbgo orderupdate](bbgo_orderupdate.md)	 - Listen to order update events
-* [bbgo pnl](bbgo_pnl.md)	 - pnl calculator
+* [bbgo pnl](bbgo_pnl.md)	 - Average Cost Based PnL Calculator
 * [bbgo run](bbgo_run.md)	 - run strategies from config file
 * [bbgo submit-order](bbgo_submit-order.md)	 - place order to the exchange
 * [bbgo sync](bbgo_sync.md)	 - sync trades and orders history

diff --git a/doc/commands/bbgo_pnl.md b/doc/commands/bbgo_pnl.md
@@ -1,6 +1,10 @@
 ## bbgo pnl
 
-pnl calculator
+Average Cost Based PnL Calculator
+
+### Synopsis
+
+This command calculates the average cost-based profit from your total trades
 
 ```
 bbgo pnl [flags]
@@ -11,7 +15,7 @@ bbgo pnl [flags]
 ```
   -h, --help               help for pnl
       --include-transfer   convert transfer records into trades
-      --limit int          number of trades (default 500)
+      --limit int          number of trades
       --session string     target exchange
       --symbol string      trading symbol
 ```