From 9f5a0f2e9325264564bc6fe9ff544c034ad16287 Mon Sep 17 00:00:00 2001
From: 魏曹先生 <1992414357@qq.com>
Date: Mon, 20 Jul 2026 14:49:47 +0800
Subject: chore: add missing docs lint and document public API

Add `#![deny(missing_docs)]` across multiple crates and fill in
documentation for all public items, including struct fields, enum
variants, trait methods, and proc macros.  Also mark two shell scripts
as executable.
---
 mingling/src/lib.rs               | 4 ++++
 mingling/src/setups/repl_basic.rs | 2 ++
 2 files changed, 6 insertions(+)

(limited to 'mingling')

diff --git a/mingling/src/lib.rs b/mingling/src/lib.rs
index 8f5dc38..f5362d5 100644
--- a/mingling/src/lib.rs
+++ b/mingling/src/lib.rs
@@ -1,4 +1,8 @@
 #![doc(html_logo_url = "https://github.com/mingling-rs/mingling/raw/main/docs/res/icon3.png")]
+#![doc(
+    html_favicon_url = "https://github.com/mingling-rs/mingling/raw/main/docs/res/favicon_small.png"
+)]
+#![deny(missing_docs)]
 #![doc = include_str!("lib.md")]
 
 #[cfg(feature = "core")]
diff --git a/mingling/src/setups/repl_basic.rs b/mingling/src/setups/repl_basic.rs
index 71a38d2..cf04372 100644
--- a/mingling/src/setups/repl_basic.rs
+++ b/mingling/src/setups/repl_basic.rs
@@ -19,7 +19,9 @@ where
 /// meaning only the last configured instance will take effect globally.
 /// Do not configure multiple prompts with different values — only one will be used.
 pub enum BasicREPLPromptSetup {
+    /// A static prompt string that is displayed before each REPL input.
     Prompt(String),
+    /// A function that returns a dynamic prompt string each time the REPL reads input.
     Func(fn() -> String),
 }
 
-- 
cgit