chore: DocStringを追加

Author: yupix

mi/note.py

@@ -10,6 +10,7 @@
 def _add_reaction(cls, reaction, note_id=None) -> bool:
     """
     指定したnoteに指定したリアクションを付与します（内部用
+
     Parameters
     ----------
     cls
@@ -21,7 +22,8 @@ def _add_reaction(cls, reaction, note_id=None) -> bool:
 
     Returns
     -------
-
+    status: bool
+        成功したならTrue,失敗ならFalse
     """
 
     if note_id:
@@ -61,6 +63,7 @@ async def delete(self) -> bool:
     async def add_reaction(self, reaction: str, note_id: str = None) -> bool:
         """
         指定したnoteに指定したリアクションを付与します
+
         Parameters
         ----------
         reaction : str
@@ -70,7 +73,8 @@ async def add_reaction(self, reaction: str, note_id: str = None) -> bool:
 
         Returns
         -------
-
+        func: bool
+            成功したならTrue,失敗ならFalse
         """
         set_auth_i(self.note, self.auth_i, True)
         return _add_reaction(self.note, reaction, note_id)
@@ -83,6 +87,22 @@ def __init__(self, data):
 
 
 class Note(object):
+    """
+
+    Methods
+    -------
+    add_file(file_id, path, name)
+        ファイルをノートに添付します
+    add_poll(data, item, expires_at, expired_after)
+        アンケートをノートに追加します
+    add_reaction(reaction, note_id)
+        ノートにリアクションを追加します
+    send()
+        ノートを送信します
+    delete(id)
+        指定されたノートを削除します
+    """
+
     def __init__(self,
                  id_: str = None,
                  created_at: str = None,
@@ -249,6 +269,7 @@ def add_poll(self, data: list = None, item: str = '', expires_at: int = None, ex
     async def add_reaction(self, reaction: str, note_id: str = None) -> bool:
         """
         指定したnoteに指定したリアクションを付与します
+
         Parameters
         ----------
         reaction : str
@@ -258,7 +279,8 @@ async def add_reaction(self, reaction: str, note_id: str = None) -> bool:
 
         Returns
         -------
-
+        func: bool
+            成功したならTrue,失敗ならFalse
         """
 
         return _add_reaction(self, reaction, note_id)
@@ -295,6 +317,11 @@ def __init__(self, data):
 
 
 class ReactionNote(object):
+    """
+    Attributes
+    ----------
+    data : dict
+    """
     def __init__(self, data):
         self.reaction = data['body'].get('reaction')
         self.user_id = data['body'].get('userId')