From 7207b8c8d7e256ceec28b4f02a41ef835d1c381a Mon Sep 17 00:00:00 2001
From: yanyongyu <yanyongyu_1@126.com>
Date: Thu, 17 Sep 2020 18:21:13 +0800
Subject: [PATCH] :pencil2: fix typo

---
 docs/api/config.md | 60 ++++++++++++++++++++++++++--------------------
 nonebot/config.py  |  2 +-
 2 files changed, 35 insertions(+), 27 deletions(-)

diff --git a/docs/api/config.md b/docs/api/config.md
index 34f05069..fd90f50e 100644
--- a/docs/api/config.md
+++ b/docs/api/config.md
@@ -67,7 +67,7 @@ NoneBot 运行所使用的 `Driver` 。继承自 `nonebot.driver.BaseDriver` 。
 
 
 * 说明:
-NoneBot 的 HTTP 和 WebSocket 服务端监听的 IP／主机名。
+NoneBot 的 HTTP 和 WebSocket 服务端监听的 IP/主机名。
 
 
 ### `port`
@@ -83,27 +83,6 @@ NoneBot 的 HTTP 和 WebSocket 服务端监听的 IP／主机名。
 NoneBot 的 HTTP 和 WebSocket 服务端监听的端口。
 
 
-### `secret`
-
-
-* 类型: `Optional[str]`
-
-
-* 默认值: `None`
-
-
-* 说明:
-上报连接 NoneBot 所需的密钥。
-
-
-* 示例:
-
-```http
-POST /cqhttp/ HTTP/1.1
-Authorization: Bearer kSLuTF2GC2Q4q4ugm3
-```
-
-
 ### `debug`
 
 
@@ -132,7 +111,7 @@ Authorization: Bearer kSLuTF2GC2Q4q4ugm3
 
 * 示例:
 
-```plain
+```default
 API_ROOT={"123456": "http://127.0.0.1:5700"}
 ```
 
@@ -160,7 +139,36 @@ API 请求超时时间，单位: 秒。
 
 
 * 说明:
-API 请求所需密钥，会在调用 API 时在请求头中携带。
+API 请求以及上报所需密钥，在请求头中携带。
+
+
+* 示例:
+
+```http
+POST /cqhttp/ HTTP/1.1
+Authorization: Bearer kSLuTF2GC2Q4q4ugm3
+```
+
+
+### `secret`
+
+
+* 类型: `Optional[str]`
+
+
+* 默认值: `None`
+
+
+* 说明:
+HTTP POST 形式上报所需签名，在请求头中携带。
+
+
+* 示例:
+
+```http
+POST /cqhttp/ HTTP/1.1
+X-Signature: sha1=f9ddd4863ace61e64f462d41ca311e3d2c1176e2
+```
 
 
 ### `superusers`
@@ -178,7 +186,7 @@ API 请求所需密钥，会在调用 API 时在请求头中携带。
 
 * 示例:
 
-```plain
+```default
 SUPER_USERS=[12345789]
 ```
 
@@ -237,7 +245,7 @@ SUPER_USERS=[12345789]
 
 * 示例:
 
-```plain
+```default
 SESSION_EXPIRE_TIMEOUT=120  # 单位: 秒
 SESSION_EXPIRE_TIMEOUT=[DD ][HH:MM]SS[.ffffff]
 SESSION_EXPIRE_TIMEOUT=P[DD]DT[HH]H[MM]M[SS]S  # ISO 8601
diff --git a/nonebot/config.py b/nonebot/config.py
index 9a9c4ffa..1680f40c 100644
--- a/nonebot/config.py
+++ b/nonebot/config.py
@@ -134,7 +134,7 @@ class Config(BaseConfig):
     - 类型: ``IPvAnyAddress``
     - 默认值: ``127.0.0.1``
     - 说明:
-      NoneBot 的 HTTP 和 WebSocket 服务端监听的 IP／主机名。
+      NoneBot 的 HTTP 和 WebSocket 服务端监听的 IP/主机名。
     """
     port: int = 8080
     """