From dc9d5ea0026a6cb6bb477d5db8e9190a79ecb337 Mon Sep 17 00:00:00 2001 From: 魏曹先生 <1992414357@qq.com> Date: Fri, 17 Jul 2026 04:04:11 +0800 Subject: docs: add module-level documentation and improve doc comments --- mingling_picker/README.md | 17 +++++++++++------ 1 file changed, 11 insertions(+), 6 deletions(-) (limited to 'mingling_picker/README.md') diff --git a/mingling_picker/README.md b/mingling_picker/README.md index c83bff4..db67825 100644 --- a/mingling_picker/README.md +++ b/mingling_picker/README.md @@ -22,15 +22,20 @@ mingling_picker = "0.3.0" Provides a clean chained-call API for declaring arguments to parse: ```rust +use mingling_picker::prelude::*; + let args: Vec<&str> = vec!["--name", "Bob", "--age", "24"]; -let result = args - .pick(&flag![name: String]) + +let (name, age) = args + .pick(&arg![name: String]) .or(|| "Alice".to_string()) - .pick(&flag![age: i32]) + .pick(&arg![age: i32]) .or(|| 24) .post(|num| num.clamp(0, 120)) - .parse(); -let (name, age): (String, i32) = a.unwrap(); + .unwrap(); + +assert_eq!(name, "Bob".to_string()); +assert_eq!(age, 24); ``` ## Parsing Function Library @@ -38,5 +43,5 @@ let (name, age): (String, i32) = a.unwrap(); Provides a pure function library `parselib` for analyzing the structure of command-line arguments. ```rust -use mingling::picker::parselib::*; +use mingling_picker::parselib::*; ``` -- cgit