diff options
| author | 魏曹先生 <1992414357@qq.com> | 2026-06-30 18:04:12 +0800 |
|---|---|---|
| committer | 魏曹先生 <1992414357@qq.com> | 2026-06-30 18:04:12 +0800 |
| commit | 03330fb5aa89b4fc2d8f753562899166ffe7c3d9 (patch) | |
| tree | 912a0d758bf191c3a3243f38de56d40005eced8a | |
| parent | bec5bf25e049bc049edb2e799d1917eb26ae7ce5 (diff) | |
docs: clean up code blocks and trailing whitespace in readme
| -rw-r--r-- | README.md | 14 | ||||
| -rw-r--r-- | docs/_zh_CN/pages/other/features.md | 7 | ||||
| -rw-r--r-- | docs/pages/other/features.md | 7 |
3 files changed, 11 insertions, 17 deletions
@@ -55,8 +55,6 @@ - 📖 [docs.rs](https://docs.rs/mingling/latest/mingling/) - 📖 Helpdoc [EN](https://mingling-rs.github.io/mingling/docs/doc.html#/) [中文](https://mingling-rs.github.io/mingling/docs/_zh_CN/index.html#/) - - <h1 align="center"> Getting Started </h1> @@ -102,11 +100,11 @@ User Input → [Dispatcher] → Entry → [Chain(s)] → Result → [Renderer] **Step4: Render** — A **Renderer** takes that result and writes it to the terminal. > [!NOTE] -> A Chain can produce a **State** type to be passed to the next Chain for further processing, +> A Chain can produce a **State** type to be passed to the next Chain for further processing, > -> or it can produce a **Result** type to be handed off to a Renderer. +> or it can produce a **Result** type to be handed off to a Renderer. -Everything in this pipeline is a **plain Rust function** with an attribute macro on top. +Everything in this pipeline is a **plain Rust function** with an attribute macro on top. You never need to manually implement traits or construct boilerplate. @@ -362,11 +360,9 @@ fn main() { In your `build.rs`, generate the shell scripts: ```rust +// BUILD TIME // Features: ["comp", "builds"] - -fn main() { - mingling::build::build_comp_scripts(env!("CARGO_PKG_NAME")).unwrap(); -} +mingling::build::build_comp_scripts(env!("CARGO_PKG_NAME")).unwrap(); ``` For enum-based completions, use `suggest_enum!`: diff --git a/docs/_zh_CN/pages/other/features.md b/docs/_zh_CN/pages/other/features.md index 8b19b31..bfd9efc 100644 --- a/docs/_zh_CN/pages/other/features.md +++ b/docs/_zh_CN/pages/other/features.md @@ -39,13 +39,12 @@ async fn handle_state_foo(foo: StateFoo) -> Next { 1. `comp` 特性下的补全脚本生成: ```rust +// BUILD TIME // Features: ["builds", "comp"] use mingling::build::build_comp_scripts; -fn main() { - // 为 `myprogram` 生成补全脚本 - build_comp_scripts("myprogram").unwrap(); -} +// 为 `myprogram` 生成补全脚本 +build_comp_scripts("myprogram").unwrap(); ``` ## 特性 `clap` diff --git a/docs/pages/other/features.md b/docs/pages/other/features.md index 891083d..813ccdd 100644 --- a/docs/pages/other/features.md +++ b/docs/pages/other/features.md @@ -39,13 +39,12 @@ Enables scripts needed for use in `build.rs`, currently including: 1. Completion script generation under the `comp` feature: ```rust +// BUILD TIME // Features: ["builds", "comp"] use mingling::build::build_comp_scripts; -fn main() { - // Generate completion scripts for `myprogram` - build_comp_scripts("myprogram").unwrap(); -} +// Generate completion scripts for `myprogram` +build_comp_scripts("myprogram").unwrap(); ``` ## Feature `clap` |
