📝Write doc for room-invitation module (#359)

Author: seng1e

docs/references/room-invitation.md

@@ -2,30 +2,12 @@
 title: RoomInvitation
 ---
 
-对群聊邀请事件的封装
+> 对群聊邀请事件的封装
 
-## RoomInvitation
-
-接受群聊的邀请
-
-**类型**: 全局类
-
-* [RoomInvitation](room-invitation.md#RoomInvitation)
-  * [.accept\(\)](room-invitation.md#RoomInvitation+accept) ⇒ `None`
-  * [.inviter\(\)](room-invitation.md#RoomInvitation+inviter) ⇒ `Contact`
-  * [.topic\(\)](room-invitation.md#RoomInvitation+topic) ⇒ `str`
-  * [~~.roomTopic\(\)~~](room-invitation.md#RoomInvitation+roomTopic) ⇒ `str`
-  * [.date\(\)](room-invitation.md#RoomInvitation+date) ⇒ `datetime`
-  * [.age\(\)](room-invitation.md#RoomInvitation+age) ⇒ `int`
-
-### async def accept\(self\) ⇒ `None`
-
-接受群聊邀请
-
-**类型**: [`RoomInvitation`](room-invitation.md#RoomInvitation)的实例方法  
-
-#### 示例
+::: wechaty.user.room_invitation.RoomInvitation.load
 
+::: wechaty.user.room_invitation.RoomInvitation.accept
+### 示例代码
 ```python
 import asyncio
 from wechaty import Wechaty, RoomInvitation
@@ -44,14 +26,8 @@ class MyBot(Wechaty):
 asyncio.run(MyBot().start())
 ```
 
-### async def inviter\(self\) ⇒ `Contact`
-
-获取群聊邀请的邀请人
-
-**类型**: [`RoomInvitation`](room-invitation.md#RoomInvitation)的实例方法  
-
-#### 示例
-
+::: wechaty.user.room_invitation.RoomInvitation.inviter
+### 示例代码
 ```python
 import asyncio
 from wechaty import Wechaty, RoomInvitation
@@ -71,14 +47,8 @@ class MyBot(Wechaty):
 asyncio.run(MyBot().start())
 ```
 
-### async def topic\(self\) ⇒ `str`
-
-获取群聊邀请的群聊名
-
-**类型**: [`RoomInvitation`](room-invitation.md#RoomInvitation)的实例方法  
-
-#### 示例
-
+::: wechaty.user.room_invitation.RoomInvitation.topic
+### 示例代码
 ```python
 import asyncio
 from wechaty import Wechaty, RoomInvitation
@@ -96,21 +66,15 @@ class MyBot(Wechaty):
 asyncio.run(MyBot().start())
 ```
 
-### ~~async def roomTopic\(\)~~
-
-**类型**: [`RoomInvitation`](room-invitation.md#RoomInvitation)的实例方法  
-**已弃用:**: 请使用 topic\(\)
-
-### async def date\(self\) ⇒ `datetime`
-
-获取群聊邀请的日期
+::: wechaty.user.room_invitation.RoomInvitation.member_count
 
-**类型**: [`RoomInvitation`](room-invitation.md#RoomInvitation)的实例方法  
+::: wechaty.user.room_invitation.RoomInvitation.member_list
 
-### async def age\(self\) ⇒ `int`
+::: wechaty.user.room_invitation.RoomInvitation.date
 
-获取当前距离已接收到的这条群聊邀请的时间的间隔, 单位为秒
+::: wechaty.user.room_invitation.RoomInvitation.age
+> 举个例子, 有条群聊邀请是`8:43:01`发送的, 而当我们在Wechaty中接收到它的时候时间已经为 `8:43:15`, 那么这时 `age()`返回的值为 `8:43:15 - 8:43:01 = 14 (秒)`
 
-举个例子, 有条群聊邀请是`8:43:01`发送的, 而当我们在Wechaty中接收到它的时候时间已经为 `8:43:15`, 那么这时 `age()`返回的值为 `8:43:15 - 8:43:01 = 14 (秒)`
+::: wechaty.user.room_invitation.RoomInvitation.from_json
 
-**类型**: [`RoomInvitation`](room-invitation.md#RoomInvitation)的实例方法  
+::: wechaty.user.room_invitation.RoomInvitation.to_json

src/wechaty/user/room_invitation.py

@@ -57,6 +57,12 @@ def __str__(self) -> str:
     async def to_str(self) -> str:
         """
         get room invitation string format description with async way
+        Args:
+            self: RoomInvitation object
+        Examples:
+            >>> invitation_str = RoomInvitation.to_str()
+        Returns:
+            str: room invitation string format description
         """
         log.info('to_str()')
         payload = await self.puppet.room_invitation_payload(
@@ -76,8 +82,12 @@ async def to_str(self) -> str:
     def load(cls, room_invitation_id: str) -> RoomInvitation:
         """
         load RoomInvitation object
-        :param room_invitation_id:
-        :return:
+        Args:
+            room_invitation_id: room invitation id
+        Examples:
+            >>> invitation = RoomInvitation.load(room_invitation_id)
+        Returns:
+            RoomInvitation: RoomInvitation object
         """
         log.info('load () <%s>', room_invitation_id)
 
@@ -87,6 +97,12 @@ def load(cls, room_invitation_id: str) -> RoomInvitation:
     async def accept(self) -> None:
         """
         accept the room invitation
+        Args:
+            self: RoomInvitation object
+        Examples:
+            >>> await invitation.accept()
+        Returns:
+            None
         """
         log.info('accept() <%s>', self)
         await self.puppet.room_invitation_accept(
@@ -108,6 +124,12 @@ async def accept(self) -> None:
     async def inviter(self) -> Contact:
         """
         get the inviter of the invitation
+        Args:
+            self: RoomInvitation object
+        Examples:
+            >>> inviter = await invitation.inviter()
+        Returns:
+            Contact: inviter of the invitation
         """
         log.info('inviter() <%s>', self)
         payload = await self.puppet.room_invitation_payload(
@@ -118,6 +140,12 @@ async def inviter(self) -> Contact:
     async def topic(self) -> str:
         """
         get the topic of the intivation
+        Args:
+            self: RoomInvitation object
+        Examples:
+            >>> topic = await invitation.topic()
+        Returns:
+            str: topic of the invitation
         """
         log.info('topic() <%s>', self)
         payload = await self.puppet.room_invitation_payload(
@@ -127,6 +155,12 @@ async def topic(self) -> str:
     async def member_count(self) -> int:
         """
         get the number of the invitation members
+        Args:
+            self: RoomInvitation object
+        Examples:
+            >>> member_count = await invitation.member_count()
+        Returns:
+            int: number of the invitation members
         """
         log.info('member_count() <%s>', self)
         payload = await self.puppet.room_invitation_payload(
@@ -136,6 +170,12 @@ async def member_count(self) -> int:
     async def member_list(self) -> List[Contact]:
         """
         get the members of the room invitation
+        Args:
+            self: RoomInvitation object
+        Examples:
+            >>> member_list = await invitation.member_list()
+        Returns:
+            List[Contact]: members of the room invitation
         """
         log.info('member_list() <%s>', self)
         payload = await self.puppet.room_invitation_payload(
@@ -155,6 +195,12 @@ async def member_list(self) -> List[Contact]:
     async def date(self) -> datetime:
         """
         get the date of the room invitation
+        Args:
+            self: RoomInvitation object
+        Examples:
+            >>> date = await invitation.date()
+        Returns:
+            datetime: date of the room invitation
         """
         log.info('date() <%s>', self)
         payload = await self.puppet.room_invitation_payload(
@@ -165,6 +211,12 @@ async def date(self) -> datetime:
     async def age(self) -> int:
         """
         get the age of the invitation timespan
+        Args:
+            self: RoomInvitation object
+        Examples:
+            >>> age = await invitation.age()
+        Returns:
+            int: age of the invitation timespan
         """
         log.info('age() <%s>', self)
         payload = await self.puppet.room_invitation_payload(
@@ -179,6 +231,12 @@ async def from_json(cls,
                         ) -> RoomInvitation:
         """
         Load the room invitation info from disk
+        Args:
+            payload: room invitation payload
+        Examples:
+            >>> invitation = await RoomInvitation.from_json(payload)
+        Returns:
+            RoomInvitation: room invitation object
         """
         if isinstance(payload, str):
             log.info('from_json() <%s>', payload)
@@ -201,6 +259,12 @@ async def from_json(cls,
     async def to_json(self) -> str:
         """
         Get the room invitation info when listened on room-invite event
+        Args:
+            self: RoomInvitation object
+        Examples:
+            >>> json_str = await invitation.to_json()
+        Returns:
+            str: room invitation info
         """
         log.info('to_json() <%s>', self)
         payload = await self.puppet.room_invitation_payload(