Skip to content

Commit 6e24f72

Browse files
committed
chore: update docs
1 parent 9c29314 commit 6e24f72

File tree

14 files changed

+871
-1689
lines changed

14 files changed

+871
-1689
lines changed

wiki/v2/api/client.md

Lines changed: 175 additions & 329 deletions
Large diffs are not rendered by default.

wiki/v2/api/client_factory.md

Lines changed: 17 additions & 40 deletions
Original file line numberDiff line numberDiff line change
@@ -1,52 +1,29 @@
11
# Client Factory
22

3+
### *class* butter.mas.clients.client_factory.ClientFactory
34

4-
### class butter.mas.clients.client_factory.ClientFactory()
55
Client factory for different types of protocols
66

7-
87
#### getClient(ip, port=None, protocol='http')
9-
Creates new client
10-
11-
12-
* **Parameters**
13-
14-
* **ip** (*str*) – robot IP
15-
16-
* **port** (*int**, **optional*) – robot port. Defaults to None.
17-
18-
* **protocol** (*str**, **optional*) – communication protocol. Defaults to “http”.
19-
20-
21-
22-
* **Returns**
23-
24-
requested client
25-
26-
27-
28-
* **Return type**
29-
30-
Client
318

9+
Creates new client
3210

11+
* **Parameters:**
12+
* **ip** (*str*) – robot IP
13+
* **port** (*int* *,* *optional*) – robot port. Defaults to None.
14+
* **protocol** (*str* *,* *optional*) – communication protocol. Defaults to “http”.
15+
* **Returns:**
16+
requested client
17+
* **Return type:**
18+
[Client](client.md#butter.mas.clients.client.Client)
3319

3420
#### getClientClass(protocol='http')
35-
Get client class
36-
37-
38-
* **Parameters**
39-
40-
**protocol** (*str**, **optional*) – communication protocol. Defaults to “http”.
41-
4221

22+
Get client class
4323

44-
* **Returns**
45-
46-
client class
47-
48-
49-
50-
* **Return type**
51-
52-
Client
24+
* **Parameters:**
25+
**protocol** (*str* *,* *optional*) – communication protocol. Defaults to “http”.
26+
* **Returns:**
27+
client class
28+
* **Return type:**
29+
[Client](client.md#butter.mas.clients.client.Client)

0 commit comments

Comments
 (0)