diff --git a/clap_complete/src/aot/mod.rs b/clap_complete/src/aot/mod.rs index bd25ca0e51f..fa73134d0c0 100644 --- 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 index 7274468f0ee..97c9845b933 100644 --- 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 index 46379cc7358..c10cf57a6de 100644 --- 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 index 2bd2a0a7939..fb3499ca5dd 100644 --- 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.