diff --git a/docs/advanced/service.md b/docs/advanced/service.md index e3132a4..afb7c0f 100644 --- a/docs/advanced/service.md +++ b/docs/advanced/service.md @@ -6,9 +6,9 @@ contributors: ["karakoo"] ## 创建 `Service` -服务 `Service` 需定义在 `services` 文件夹下, 并继承 `gram_core.base_service.BaseService` +服务 `Service` 需定义在 `services` 文件夹下,并继承 `gram_core.base_service.BaseService` -每个 `Service` 都应包含 `initialize` 和 `shutdown` 方法, 且这两个方法都为异步方法 +每个 `Service` 都应包含 `initialize` 和 `shutdown` 方法,且这两个方法都为异步方法 ```python from gram_core.base_service import BaseService @@ -27,13 +27,13 @@ class TestService(BaseService): ## 分类 -v4 的服务有三类 `Dependence(基础服务)` 、 `Component(组件)` 、 `Service(普通服务)` +v4 的服务有三类 `Dependence(基础服务)`、`Component(组件)`、`Service(普通服务)` ### 第一类:基础服务 基础服务是不需要依赖于其他任何服务和组件的服务,它会被最先初始化和运行 -拥有异步方法 initialize 和 shutdown 来管理它的生命周期(后续可能会加入 heartbeat 方法来保持基础服务的一些功能) +拥有异步方法 initialize 和 shutdown 来管理它的生命周期 (后续可能会加入 heartbeat 方法来保持基础服务的一些功能) 存放于 `core/dependence` 目录下 diff --git a/docs/docker/docker.md b/docs/docker/docker.md index e604484..78ed8c3 100644 --- a/docs/docker/docker.md +++ b/docs/docker/docker.md @@ -4,7 +4,7 @@ contributors: ["cworld1"] # Docker 快速部署 -## 1. 安装 `docker` 和 `docker-compose` +## 1。安装 `docker` 和 `docker-compose` ```bash curl -fsSL https://get.docker.com | bash -s docker @@ -20,7 +20,7 @@ docker-compose version > 不同系统安装命令可能略有差异,详见:[Docker Documentation](https://docs.docker.com/compose/install/) > -## 2. 克隆本项目 +## 2。克隆本项目 ::: tip @@ -33,7 +33,7 @@ git clone https://github.com/PaiGramTeam/PaiGram.git cd PaiGram ``` -## 3. 修改配置文件 +## 3。修改配置文件 ```bash cp .env.example .env @@ -57,7 +57,7 @@ REDIS_PASSWORD="" 以及 bot token 等参数。详见 [Env Settings](../quick-start/env) -### 4. 运行 +### 4。运行 ```bash docker-compose up -d diff --git a/docs/extra/pga.md b/docs/extra/pga.md index bf930a7..0d95656 100644 --- a/docs/extra/pga.md +++ b/docs/extra/pga.md @@ -1,6 +1,6 @@ # python-genshin-artifact 伤害计算 -PaiGram 通过调用 python-genshin-artifact (下文简称PGA) 模块实现角色伤害计算,该模块将 Rust 实现的 [genshin_artifact](https://github.com/wormtql/genshin_artifact) 库包装为 python 模块供 PaiGram 使用。 +PaiGram 通过调用 python-genshin-artifact (下文简称 PGA) 模块实现角色伤害计算,该模块将 Rust 实现的 [genshin_artifact](https://github.com/wormtql/genshin_artifact) 库包装为 python 模块供 PaiGram 使用。 ## 依赖 @@ -29,7 +29,7 @@ pip install python-genshin-artifact ... ``` -2. 浏览至项目主目录下,用 `cargo` 编译 Rust 代码(可选步骤) +2. 浏览至项目主目录下,用 `cargo` 编译 Rust 代码 (可选步骤) ``` $ cd python-genshin-artifact/ @@ -61,9 +61,9 @@ pip install python-genshin-artifact ### 编译 wheel -如果需要导出给其它项目测试或使用(例如 PaiGram),需要通过 `maturin` 将模块编译成 `.whl` 格式以便其它 Python 虚拟环境安装。 +如果需要导出给其它项目测试或使用 (例如 PaiGram),需要通过 `maturin` 将模块编译成 `.whl` 格式以便其它 Python 虚拟环境安装。 -1. `maturin build`: +1. `maturin build`: ``` $ maturin build --out dist diff --git a/docs/quick-start/config.md b/docs/quick-start/config.md index 5bbcc12..f69890b 100644 --- a/docs/quick-start/config.md +++ b/docs/quick-start/config.md @@ -71,7 +71,7 @@ ADMINS=[{ "username": "", "user_id": -1 }] ERROR_NOTIFICATION_CHAT_ID=chat_id ``` -#### 文章推送群组 可选配置项 +#### 文章推送群组 (可选配置项) 可选。