Skip to content

Commit 0583c4d

Browse files
committed
[EN-1570] docs edits
1 parent 02e17bd commit 0583c4d

File tree

2 files changed

+11
-8
lines changed

2 files changed

+11
-8
lines changed

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -99,7 +99,7 @@ trade_sub = trade_sub.set_event_handler(trade_handler)
9999
trade_sub = trade_sub.add_symbols(['C', 'AAPL'])
100100
```
101101

102-
For timed subscription you may provide either datetime object or string. String might be incomlete, in
102+
For timed subscription you may provide either datetime object or string. String might be incomplete, in
103103
this case you will get warning with how your provided date parsed automatically.
104104

105105

docs/basic_usage.rst

Lines changed: 10 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -9,18 +9,21 @@ library, the highest is Python wrapper classes. Cython level in the
99
middle aims to connect these two. Here we are going to look into Python
1010
level.
1111

12-
Python level, in its turn, mainly consists of three class types. The
13-
first one is the Endpoint. This class is responsible for connection
14-
management.
12+
Python level, in its turn, mainly consists of three class types:
1513

16-
The Endpoint is also responsible for creating dependent classes, for
14+
1. Endpoint
15+
2. Subscription
16+
3. EventHandler
17+
18+
The **Endpoint** is responsible for connection management and creating dependent classes, for
1719
example Subscription. One Endpoint may have several different
18-
Subscriptions, but each Subscription is related to one Endpoint. This
19-
class sets the type of subscription (stream or timed), the type of
20+
Subscriptions, but each Subscription is related to one Endpoint.
21+
22+
**Subscription** class sets the type of subscription (stream or timed), the type of
2023
events (e.g. Trade, Candle), etc.
2124

2225
After you specified the data you want to receive, you have to specify
23-
how to process upcoming events. This is where the EventHandler class and
26+
how to process upcoming events. This is where the **EventHandler** class and
2427
its children come into play. Every time an event arrives Cython event
2528
listener will call ``self.update(event)`` method. You have to inherit
2629
from the EventHandler class and redefine the update method. Or you may

0 commit comments

Comments
 (0)