aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
author魏曹先生 <1992414357@qq.com>2026-07-17 04:12:23 +0800
committer魏曹先生 <1992414357@qq.com>2026-07-17 04:12:23 +0800
commitab803966fedb640fedc95e22259e09b2922b22a0 (patch)
tree1c2170f576916dbbac4fd0cd10d19063debb5bbf
parentdc9d5ea0026a6cb6bb477d5db8e9190a79ecb337 (diff)
docs(picker): replace doc comment with `include_str!` reference
-rw-r--r--mingling_pathf/README.md6
-rw-r--r--mingling_picker/src/picker.rs8
2 files changed, 4 insertions, 10 deletions
diff --git a/mingling_pathf/README.md b/mingling_pathf/README.md
index 6d8857a..89d1811 100644
--- a/mingling_pathf/README.md
+++ b/mingling_pathf/README.md
@@ -18,16 +18,16 @@ Enable the `pathf` feature in `Cargo.toml`:
```toml
[dependencies.mingling]
# Used to modify the generation behavior of `gen_program!`
-features = ["pathf"]
+features = ["pathf"]
[build-dependencies.mingling]
# Provides the `analyze_and_build_type_mapping` function
-features = ["builds", "pathf"]
+features = ["builds", "pathf"]
```
Create a `build.rs` in the project root:
-```rust
+```rust,ignore
fn main() {
mingling::build::analyze_and_build_type_mapping();
}
diff --git a/mingling_picker/src/picker.rs b/mingling_picker/src/picker.rs
index 4efb532..69b1671 100644
--- a/mingling_picker/src/picker.rs
+++ b/mingling_picker/src/picker.rs
@@ -10,13 +10,7 @@ pub use result::*;
use crate::{Pickable, PickerArg, PickerArgResult};
-/// Picker, used to record all states of a parameter parsing
-///
-/// Includes the following:
-///
-/// - Basic arguments
-/// - Parsing states
-/// - Parsing results
+#[doc = include_str!("../README.md")]
pub struct Picker<'a, Route = ()> {
route_phantom: PhantomData<Route>,