Skip to content
This repository was archived by the owner on May 28, 2022. It is now read-only.

Commit a6a5da3

Browse files
committed
chore: DocStringを追加
1 parent 919fc03 commit a6a5da3

File tree

1 file changed

+20
-1
lines changed

1 file changed

+20
-1
lines changed

mi/router.py

Lines changed: 20 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,21 @@ class Router:
1313
----------
1414
web_socket : Any
1515
WebSocketクライアント
16+
17+
Methods
18+
-------
19+
channels:
20+
与えられたlistを元にチャンネルに接続します
21+
global_time_line:
22+
WebSocketでGlobalTimeLineに接続します
23+
main_channel:
24+
WebSocketでMainチャンネルに接続します
25+
home_time_line:
26+
WebSocketでHomeTimeLineに接続します
27+
local_time_line:
28+
WebSocketでLocalTimeLineに接続します
29+
capture_message:
30+
与えられたメッセージを元にnote idを取得し、そのメッセージをon_message等の監視対象に追加します
1631
"""
1732

1833
def __init__(self, web_socket):
@@ -21,6 +36,7 @@ def __init__(self, web_socket):
2136
async def channels(self, channel_list: list) -> None:
2237
"""
2338
与えられたlistを元にチャンネルに接続します
39+
2440
Parameters
2541
----------
2642
channel_list : List[str]
@@ -60,6 +76,7 @@ async def global_time_line(self) -> None:
6076
async def main_channel(self) -> None:
6177
"""
6278
WebSocketでMainチャンネルに接続します
79+
6380
Returns
6481
-------
6582
None: None
@@ -78,6 +95,7 @@ async def main_channel(self) -> None:
7895
async def home_time_line(self) -> None:
7996
"""
8097
WebSocketでHomeTimeLineに接続します
98+
8199
Returns
82100
-------
83101
None: None
@@ -96,6 +114,7 @@ async def home_time_line(self) -> None:
96114
async def local_time_line(self) -> None:
97115
"""
98116
WebSocketでLocalTimeLineに接続します
117+
99118
Returns
100119
-------
101120
None: None
@@ -121,7 +140,7 @@ async def capture_message(self, message: Message) -> None:
121140
122141
Returns
123142
-------
124-
143+
None: None
125144
"""
126145
if hasattr(message, 'id'):
127146
await self.web_socket.send(json.dumps({

0 commit comments

Comments
 (0)