From 0d986de09073704ee015c3e4fdc625ed498e9449 Mon Sep 17 00:00:00 2001 From: Richard Chien Date: Thu, 27 Dec 2018 12:14:19 +0800 Subject: [PATCH] Update docs --- docs/api.md | 26 ++++++++++++++++++++++++-- docs/changelog.md | 1 + 2 files changed, 25 insertions(+), 2 deletions(-) diff --git a/docs/api.md b/docs/api.md index 45735172..d5d38c35 100644 --- a/docs/api.md +++ b/docs/api.md @@ -438,6 +438,28 @@ sidebar: auto 在 `127.0.0.1:8080` 运行全局 NoneBot 对象。 +### `load_plugin(module_name)` + +- **说明:** + + 加载插件(等价于导入模块)。 + +- **参数:** + + - `module_name: str`: 模块名 + +- **返回:** + + - `bool`: 加载成功 + +- **用法:** + + ```python + none.load_plugin('none.plugins.base') + ``` + + 加载 `none.plugins.base` 插件。 + ### `load_plugins(plugin_dir, module_prefix)` - **说明:** @@ -451,7 +473,7 @@ sidebar: auto - **返回:** - - `None` + - `int:` 加载成功的插件数量 - **用法:** @@ -470,7 +492,7 @@ sidebar: auto - **返回:** - - `None` + - `int:` 加载成功的插件数量 - **用法:** diff --git a/docs/changelog.md b/docs/changelog.md index 2feccd30..23fa8e44 100644 --- a/docs/changelog.md +++ b/docs/changelog.md @@ -7,6 +7,7 @@ sidebar: auto ## next - 修复使用多级命令时,命令查找会出现异常的情况 +- 调整 `none.load_plugins()` 等方法,返回加载成功的插件数量,并新增 `none.load_plugin()` 方法用于加载单个插件模块 ## v0.5.2