Skip to content

Commit 2560a6d

Browse files
committed
docs: symbols in subscribe converted candles are not optional
1 parent 140d0ee commit 2560a6d

File tree

1 file changed

+1
-1
lines changed

1 file changed

+1
-1
lines changed

lib/cryptomarket/websocket/market_data_client.rb

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -72,7 +72,7 @@ def subscribe_to_candles(callback:, period:, symbols:, limit: nil, result_callba
7272
#
7373
# +Proc+ +callback+:: A +Proc+ that recieves notifications as a hash of candles indexed by symbol, and the type of notification (either 'snapshot' or 'update')
7474
# +String+ +target_currency+:: Target currency for conversion
75-
# +Array[String]+ +symbols+:: Optional. A list of symbols
75+
# +Array[String]+ +symbols+:: A list of symbols
7676
# +String+ +period+:: A valid tick interval. 'M1' (one minute), 'M3', 'M5', 'M15', 'M30', 'H1' (one hour), 'H4', 'D1' (one day), 'D7', '1M' (one month). Default is 'M30'
7777
# +String+ +from+:: Optional. Initial value of the queried interval. As DateTime
7878
# +String+ +till+:: Optional. Last value of the queried interval. As DateTime

0 commit comments

Comments
 (0)