docs(complete): Redistribute dynamic's documentation

clap-rs · Aug 16, 2024 · e46263a · e46263a
1 parent de723aa
commit e46263a
Show file tree

Hide file tree

Showing 4 changed files with 21 additions and 5 deletions.
diff --git a/clap_complete/src/aot/mod.rs b/clap_complete/src/aot/mod.rs
@@ -8,6 +8,10 @@
 //! [`Shell`] is a convenience `enum` for an argument value type that implements `Generator`
 //! for each natively-supported shell type.
 //!
+//! To customize completions, see
+//! - [`ValueHint`]
+//! - [`ValueEnum`][clap::ValueEnum]
+//!
 //! ## Example
 //!
 //! ```rust,no_run

diff --git a/clap_complete/src/command/mod.rs b/clap_complete/src/command/mod.rs
@@ -46,6 +46,11 @@ pub use shells::*;
 
 /// A completion subcommand to add to your CLI
 ///
+/// To customize completions, see
+/// - [`ValueHint`][crate::ValueHint]
+/// - [`ValueEnum`][clap::ValueEnum]
+/// - [`ArgValueCompleter`][crate::ArgValueCompleter]
+///
 /// **Warning:** `stdout` should not be written to before [`CompleteCommand::complete`] has had a
 /// chance to run.
 ///
@@ -113,6 +118,11 @@ impl CompleteCommand {
 
 /// A completion subcommand to add to your CLI
 ///
+/// To customize completions, see
+/// - [`ValueHint`][crate::ValueHint]
+/// - [`ValueEnum`][clap::ValueEnum]
+/// - [`ArgValueCompleter`][crate::ArgValueCompleter]
+///
 /// **Warning:** `stdout` should not be written to before [`CompleteArgs::complete`] has had a
 /// chance to run.
 ///

diff --git a/clap_complete/src/dynamic/mod.rs b/clap_complete/src/dynamic/mod.rs
@@ -1,9 +1,6 @@
-//! Complete commands within shells
+//! `clap`-native completion system
 //!
-//! To customize completions, see
-//! - [`ValueHint`][crate::ValueHint]
-//! - [`ValueEnum`][clap::ValueEnum]
-//! - [`ArgValueCompleter`]
+//! See [`complete()`]
 
 mod candidate;
 mod complete;

diff --git a/clap_complete/src/env/mod.rs b/clap_complete/src/env/mod.rs
@@ -16,6 +16,11 @@
 //! }
 //! ```
 //!
+//! To customize completions, see
+//! - [`ValueHint`][crate::ValueHint]
+//! - [`ValueEnum`][clap::ValueEnum]
+//! - [`ArgValueCompleter`][crate::ArgValueCompleter]
+//!
 //! To source your completions:
 //!
 //! **WARNING:** We recommend re-sourcing your completions on upgrade.