Skip to content

Commit

Permalink
fix: 修复python文档语病问题
Browse files Browse the repository at this point in the history
  • Loading branch information
@DaiJiChen @traveler-vee
DaiJiChen authored and traveler-vee committed Apr 21, 2022
1 parent 4d51425 commit ca0153c
Show file tree
Hide file tree
Showing 11 changed files with 18 additions and 28 deletions.
4 changes: 2 additions & 2 deletions docs/develop/pythonsdk/api/channel_permissions/get_channel_permissions.md
View file
Expand Up @@ -35,7 +35,7 @@ async def demo():
| 字段名 | 必填 | 类型 | 描述 |
| --------- | ---- | ------ | ----------------------------------------- |
| channel_id | 是 | string | 子频道 ID |
| user_id | 是 | string | 用户 ID ，参考 [User](./../model/user.md) |
| user_id | 是 | string | 用户 ID ，参考 [User](../../model/user.md) |

## 返回说明

Expand All @@ -46,7 +46,7 @@ async def demo():
| 字段名 | 类型 | 描述 |
| ----------- | ------ | ------------------------------------------------------ |
| channel_id | string | 子频道 ID |
| user_id | string | 用户 ID，参考 [User](./../model/user.md) |
| user_id | string | 用户 ID，参考 [User](../../model/user.md) |
| permissions | string | 用户拥有的子频道权限，参考 [Permissions](#permissions) |

### Permissions
Expand Down
6 changes: 3 additions & 3 deletions docs/develop/pythonsdk/api/guild/guild_role/create_guild_role.md
View file
Expand Up @@ -10,7 +10,7 @@ import qqbot
token = qqbot.Token({appid}, {token})

api = qqbot.GuildRoleAPI(token, False)
result = api.create_guild_role(guild_id,role_info)
result = api.create_guild_role(guild_id, role_info)
```

::: warning 注意
Expand All @@ -22,9 +22,9 @@ result = api.create_guild_role(guild_id,role_info)
| 字段名 | 必填 | 类型 | 描述 |
| -------- | ---- | --------------------- | -------------- |
| guild_id | 是 | string | 频道 ID |
| role_info | 是 | [RoleInfo](#roleinfo) | 频道身份组参数 |
| role_info | 是 | [RoleUpdateInfo](#roleupdateinfo) | 频道身份组参数 |

### RoleInfo
### RoleUpdateInfo

| 字段名 | 必填 | 类型 | 描述 |
| ------ | ---- | ------ | -------------------------------------------------------------- |
Expand Down
9 changes: 2 additions & 7 deletions docs/develop/pythonsdk/api/guild/guild_role/create_guild_role_member.md
View file
Expand Up @@ -27,13 +27,8 @@ result = api.create_guild_role_member(guild_id, role_id, user_id, channel)
| guild_id | 是 | string | 频道 ID |
| role_id | 是 | string | 身份组 ID |
| user_id | 是 | string | 用户 ID |
| channel | 是 | [Channel](#channel) | 接收一个只填充了子频道 ID 字段的对象 |

### Channel

| 字段名 | 类型 | 描述 |
| ------ | ------ | --------- |
| id | string | 子频道 ID |
| ~~channel~~ | 否 | ~~Channel 对象~~ | ~~只填充 id 属性的 Channel 对象~~(**已弃用，请使用 channelId**) |
| channel_id | 否 | string | 子频道 ID |

## 返回说明

Expand Down
9 changes: 2 additions & 7 deletions docs/develop/pythonsdk/api/guild/guild_role/delete_guild_role_member.md
View file
Expand Up @@ -26,13 +26,8 @@ result = api.delete_guild_role_member(guild_id, role_id, user_id, channel)
| guild_id | 是 | string | 频道 ID |
| role_id | 是 | string | 身份组 ID |
| user_id | 是 | string | 用户 ID |
| channel | 是 | [Channel](#channel) | 接收一个只填充了子频道 ID 字段的对象 |

### Channel

| 字段名 | 类型 | 描述 |
| ------ | ------ | --------- |
| id | string | 子频道 ID |
| ~~channel~~ | 否 | ~~Channel 对象~~ | ~~只填充 id 属性的 Channel 对象~~(**已弃用，请使用 channelId**) |
| channel_id | 否 | string | 子频道 ID

## 返回说明

Expand Down
4 changes: 2 additions & 2 deletions docs/develop/pythonsdk/api/guild/guild_role/update_guild_role.md
View file
Expand Up @@ -23,9 +23,9 @@ result = api.update_guild_role(guild_id, role_id, role_info)
| --------- | ---- | --------------------- | -------------- |
| guild_id | 是 | string | 频道 ID |
| role_id | 是 | string | 身份组 ID |
| role_info | 是 | [RoleInfo](#roleinfo) | 频道身份组参数 |
| role_info | 是 | [RoleUpdateInfo](#roleupdateinfo) | 频道身份组参数 |

### RoleInfo
### RoleUpdateInfo

| 字段名 | 必填 | 类型 | 描述 |
| ------ | ---- | ------ | -------------------------------------------------------------- |
Expand Down
4 changes: 2 additions & 2 deletions docs/develop/pythonsdk/api/member/get_guild_member.md
View file
Expand Up @@ -9,7 +9,7 @@ import qqbot

token = qqbot.Token({appid}, {token})
api = qqbot.GuildMemberAPI(token, False)
members = api.get_guild_member(guild_id, user_id)
member = api.get_guild_member(guild_id, user_id)
```

## 参数说明
Expand All @@ -29,7 +29,7 @@ members = api.get_guild_member(guild_id, user_id)
| --------- | ------------- | -------------------------------------------------------------------------------------------- |
| user | [User](#user) | 用户的频道基础信息，只有成员相关接口中会填充此信息 |
| nick | string | 用户在频道内的昵称 |
| roles | string[] | 用户在频道内的身份组 ID，默认值可参考[DefaultRoleIDs](../guild/role_model.md#DefaultRoleIDs) |
| roles | string[] | 用户在频道内的身份组 ID，默认值可参考[DefaultRoleIDs](../../model/role.md#defaultroleids) |
| joined_at | string | 用户加入频道的时间，是个 `ISO8601 timestamp` 字符串，例："2021-11-23T15:16:48+08:00" |

## User
Expand Down
2 changes: 1 addition & 1 deletion docs/develop/pythonsdk/api/member/get_guild_members.md
View file
Expand Up @@ -38,7 +38,7 @@ members = api.get_guild_members(guild_id, query_params)
| --------- | ------------- | -------------------------------------------------------------------------------------------- |
| user | [User](#user) | 用户的频道基础信息，只有成员相关接口中会填充此信息 |
| nick | string | 用户在频道内的昵称 |
| roles | string[] | 用户在频道内的身份组 ID，默认值可参考[DefaultRoleIDs](../guild/role_model.md#DefaultRoleIDs) |
| roles | string[] | 用户在频道内的身份组 ID，默认值可参考[DefaultRoleIDs](../../model/role.md#defaultroleids) |
| joined_at | string | 用户加入频道的时间，是个 `ISO8601 timestamp` 字符串，例："2021-11-23T15:16:48+08:00" |

## User
Expand Down
2 changes: 1 addition & 1 deletion docs/develop/pythonsdk/api/message/message_format.md
View file
Expand Up @@ -59,7 +59,7 @@ msg_api.post_message(channel_id, message_send_request)
| @用户 | `<@user_id>` | 解析为 `@用户` 标签 | `<@1234000000001>`
| @所有人 | `@everyone` | 解析为 `@所有人` 标签，需要机器人拥有发送 `@所有人` 消息的权限 | `@everyone` |
| #子频道 | `<#channel_id>` | 解析为 `#子频道` 标签，点击可以跳转至子频道，仅支持当前频道内的子频道 | `<#12345>` |
| 表情 | `<emoji:id>` | 解析为系统表情，具体表情 id 参考 [Emoji 列表](../model/emoji.md#Emoji-列表)，仅支持 type=1 的系统表情，type=2 的 emoji 表情直接按字符串填写即可 | `<emoji:4>` 解析为得意表情 |
| 表情 | `<emoji:id>` | 解析为系统表情，具体表情 id 参考 [Emoji 列表](../../model/emoji.md#Emoji-列表)，仅支持 type=1 的系统表情，type=2 的 emoji 表情直接按字符串填写即可 | `<emoji:4>` 解析为得意表情 |

## 返回说明

Expand Down
2 changes: 1 addition & 1 deletion docs/develop/pythonsdk/api/message/post_message.md
View file
Expand Up @@ -10,7 +10,7 @@
- 不论主动消息还是被动消息，在一个子频道中，每 `1s` 只能发送 `5` 条消息。
- 被动回复消息有效期为 `5` 分钟，超时会报错。
- **发送消息接口要求机器人接口需要链接到 `websocket gateway` 上保持在线状态**。
- 有关主动消息审核，可以通过 [Intents](../../api/gateway/intents.md) 中审核事件 `MESSAGE_AUDIT` 返回 [MessageAudited](../model/message.md#messageaudited) 对象获取结果。
- 有关主动消息审核，可以通过 [Intents](../../api/gateway/intents.md) 中审核事件 `MESSAGE_AUDIT` 返回 [MessageAudited](../../model/message.md#messageaudited) 对象获取结果。

:::

Expand Down
2 changes: 1 addition & 1 deletion docs/develop/pythonsdk/api/schedule/post_schedule.md
View file
Expand Up @@ -52,7 +52,7 @@ async def demo():
| start_timestamp | 是 | string | 日程开始时间戳(**`ms`**) ，**日程开始时间必须大于传当前时间** |
| end_timestamp | 是 | string | 日程结束时间戳(**`ms`**) ，**日程结束时间必须大于日程开始时间** |
| creator | 否 | [Member](#member) | 创建者 |
| jump_channel_id | 否 | string | 日程开始时跳转到的[子频道 ID](../model/channel.md) |
| jump_channel_id | 否 | string | 日程开始时跳转到的[子频道 ID](../../model/channel.md) |
| remind_type | 是 | string | 日程提醒类型，取值参考[RemindType](#remindtype) |

## 返回说明
Expand Down
2 changes: 1 addition & 1 deletion docs/develop/pythonsdk/model/channel.md
View file
Expand Up @@ -17,7 +17,7 @@
| private_type | string | 子频道私密类型 [PrivateType](#privatetype) |
| speak_permission | number | 子频道发言权限 [SpeakPermission](#speakpermission) |
| application_id | string | 用于标识应用子频道应用类型，仅应用子频道时会使用该字段，具体定义请参考 [应用子频道的应用类型](#应用子频道的应用类型) |
| permissions | string | 用户拥有的子频道权限 [Permissions](../model/channel_permission.md#permissions)
| permissions | string | 用户拥有的子频道权限 [Permissions](./channel_permission.md#permissions)

### 有关 position 的说明

Expand Down

0 comments on commit ca0153c

Please sign in to comment.