From e32019f15d0015841b7b2796ab61afcab1e6c2fd Mon Sep 17 00:00:00 2001 From: StarHeart Date: Mon, 26 Dec 2022 10:56:16 +0800 Subject: [PATCH] =?UTF-8?q?:memo:=20Docs:=20=E6=9B=B4=E6=96=B0=E6=B5=8B?= =?UTF-8?q?=E8=AF=95=E6=96=87=E6=A1=A3=E4=B8=AD=E7=9A=84=E8=BF=9E=E6=8E=A5?= =?UTF-8?q?=E6=96=B9=E5=BC=8F&=E7=BB=86=E5=8C=96=E6=8F=92=E4=BB=B6?= =?UTF-8?q?=E5=8F=91=E5=B8=83=E6=8F=8F=E8=BF=B0=20(#1504)?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- website/docs/advanced/publish-plugin.md | 6 +++++- website/docs/advanced/unittest/test-adapters.md | 4 ++-- .../version-2.0.0rc2/advanced/publish-plugin.md | 6 +++++- .../version-2.0.0rc2/advanced/unittest/test-adapters.md | 4 ++-- 4 files changed, 14 insertions(+), 6 deletions(-) diff --git a/website/docs/advanced/publish-plugin.md b/website/docs/advanced/publish-plugin.md index 651c5d5a..da93f644 100644 --- a/website/docs/advanced/publish-plugin.md +++ b/website/docs/advanced/publish-plugin.md @@ -20,7 +20,11 @@ options: 您可以选择自己喜欢的方式将插件发布到 [**PyPI**](https://pypi.org/),如使用 [**setuptools**](https://pypi.org/project/setuptools/) 或 [**Poetry**](https://pypi.org/project/poetry/)。 -发布时,请您为自己的插件取一个清晰易懂的名字。通常而言,一款 NoneBot2 插件名称使用 `nonebot-plugin-` 作为前缀(如`nonebot-plugin-foo`),以 `nonebot_plugin_` 作为包名的前缀(如`nonebot_plugin_foo`),这并非强制规范,而是为了防止与其他 PyPI 包产生冲突,所以我们推荐您在没有特殊需求的情况下这样做。 +发布时,请您为自己的插件取一个清晰易懂的名字。通常而言,一款 NoneBot2 插件名称使用 `nonebot-plugin-` 作为 PyPI 项目名前缀(如`nonebot-plugin-foo`),以 `nonebot_plugin_` 作为 Python 包名的前缀(如`nonebot_plugin_foo`),这并非强制规范,而是为了防止与其他 PyPI 包产生冲突,所以我们推荐您在没有特殊需求的情况下这样做。 + +:::warning +虽然在 NoneBot 2 载入插件时,插件的 Python 包名中可以使用 `-`,但是在 Python 的 import 语句中,`-` 不会被解析为包名的一部分。如果插件需要向外界提供 import 语法导入的支持,应在 Python 包名中使用 `_` 代替 `-`。 +::: 发布后,请确保您的插件已能公开的从 PyPI 访问到,试着检查您的插件在 PyPI 的地址,如 `https://pypi.org/project/<您的 NoneBot2 插件项目名>`。 diff --git a/website/docs/advanced/unittest/test-adapters.md b/website/docs/advanced/unittest/test-adapters.md index 04f7c743..1c08d1e8 100644 --- a/website/docs/advanced/unittest/test-adapters.md +++ b/website/docs/advanced/unittest/test-adapters.md @@ -49,8 +49,8 @@ async def init_adapter(app: App, import_hook): 1. 反向 HTTP(WebHook) 2. 反向 WebSocket -3. ~~正向 HTTP(尚未实现)~~ -4. ~~正向 WebSocket(尚未实现)~~ +3. 正向 HTTP +4. 正向 WebSocket NoneBug 的 `test_server` 方法可以供我们测试反向连接方式。 diff --git a/website/versioned_docs/version-2.0.0rc2/advanced/publish-plugin.md b/website/versioned_docs/version-2.0.0rc2/advanced/publish-plugin.md index 651c5d5a..da93f644 100644 --- a/website/versioned_docs/version-2.0.0rc2/advanced/publish-plugin.md +++ b/website/versioned_docs/version-2.0.0rc2/advanced/publish-plugin.md @@ -20,7 +20,11 @@ options: 您可以选择自己喜欢的方式将插件发布到 [**PyPI**](https://pypi.org/),如使用 [**setuptools**](https://pypi.org/project/setuptools/) 或 [**Poetry**](https://pypi.org/project/poetry/)。 -发布时,请您为自己的插件取一个清晰易懂的名字。通常而言,一款 NoneBot2 插件名称使用 `nonebot-plugin-` 作为前缀(如`nonebot-plugin-foo`),以 `nonebot_plugin_` 作为包名的前缀(如`nonebot_plugin_foo`),这并非强制规范,而是为了防止与其他 PyPI 包产生冲突,所以我们推荐您在没有特殊需求的情况下这样做。 +发布时,请您为自己的插件取一个清晰易懂的名字。通常而言,一款 NoneBot2 插件名称使用 `nonebot-plugin-` 作为 PyPI 项目名前缀(如`nonebot-plugin-foo`),以 `nonebot_plugin_` 作为 Python 包名的前缀(如`nonebot_plugin_foo`),这并非强制规范,而是为了防止与其他 PyPI 包产生冲突,所以我们推荐您在没有特殊需求的情况下这样做。 + +:::warning +虽然在 NoneBot 2 载入插件时,插件的 Python 包名中可以使用 `-`,但是在 Python 的 import 语句中,`-` 不会被解析为包名的一部分。如果插件需要向外界提供 import 语法导入的支持,应在 Python 包名中使用 `_` 代替 `-`。 +::: 发布后,请确保您的插件已能公开的从 PyPI 访问到,试着检查您的插件在 PyPI 的地址,如 `https://pypi.org/project/<您的 NoneBot2 插件项目名>`。 diff --git a/website/versioned_docs/version-2.0.0rc2/advanced/unittest/test-adapters.md b/website/versioned_docs/version-2.0.0rc2/advanced/unittest/test-adapters.md index 04f7c743..1c08d1e8 100644 --- a/website/versioned_docs/version-2.0.0rc2/advanced/unittest/test-adapters.md +++ b/website/versioned_docs/version-2.0.0rc2/advanced/unittest/test-adapters.md @@ -49,8 +49,8 @@ async def init_adapter(app: App, import_hook): 1. 反向 HTTP(WebHook) 2. 反向 WebSocket -3. ~~正向 HTTP(尚未实现)~~ -4. ~~正向 WebSocket(尚未实现)~~ +3. 正向 HTTP +4. 正向 WebSocket NoneBug 的 `test_server` 方法可以供我们测试反向连接方式。