diff --git a/clap_complete/src/dynamic/completer.rs b/clap_complete/src/dynamic/completer.rs index 8c8cb93cc6f..232dd4bfc37 100644 --- a/clap_complete/src/dynamic/completer.rs +++ b/clap_complete/src/dynamic/completer.rs @@ -16,7 +16,7 @@ pub trait Completer { completer: &str, buf: &mut dyn std::io::Write, ) -> Result<(), std::io::Error>; - /// Complete the command + /// Complete the given command fn write_complete( &self, cmd: &mut clap::Command, @@ -26,7 +26,7 @@ pub trait Completer { ) -> Result<(), std::io::Error>; } -/// Complete the command specified +/// Complete the given command pub fn complete( cmd: &mut clap::Command, args: Vec, diff --git a/clap_complete/src/dynamic/mod.rs b/clap_complete/src/dynamic/mod.rs index f7c985704c9..ed72565378d 100644 --- a/clap_complete/src/dynamic/mod.rs +++ b/clap_complete/src/dynamic/mod.rs @@ -1,4 +1,6 @@ //! Complete commands within shells +//! +//! For quick-start, see [`shells::CompleteCommand`] mod completer; diff --git a/clap_complete/src/dynamic/shells/bash.rs b/clap_complete/src/dynamic/shells/bash.rs index 43c128e5b4e..1308e67a35d 100644 --- a/clap_complete/src/dynamic/shells/bash.rs +++ b/clap_complete/src/dynamic/shells/bash.rs @@ -1,6 +1,6 @@ use unicode_xid::UnicodeXID as _; -/// Bash completions +/// Completion support for Bash #[derive(Copy, Clone, PartialEq, Eq, Debug)] pub struct Bash; diff --git a/clap_complete/src/dynamic/shells/fish.rs b/clap_complete/src/dynamic/shells/fish.rs index 9d7e8c6846b..cfb95195f2c 100644 --- a/clap_complete/src/dynamic/shells/fish.rs +++ b/clap_complete/src/dynamic/shells/fish.rs @@ -1,4 +1,4 @@ -/// Fish completions +/// Completion support for Fish #[derive(Copy, Clone, PartialEq, Eq, Debug)] pub struct Fish; diff --git a/clap_complete/src/dynamic/shells/mod.rs b/clap_complete/src/dynamic/shells/mod.rs index 54d23a3d4fb..c8e96ec2b10 100644 --- a/clap_complete/src/dynamic/shells/mod.rs +++ b/clap_complete/src/dynamic/shells/mod.rs @@ -13,6 +13,9 @@ use std::io::Write as _; use crate::dynamic::Completer as _; +/// A subcommand definition to `flatten` into your CLI +/// +/// This provides a one-stop solution for integrating completions into your CLI #[derive(clap::Subcommand)] #[allow(missing_docs)] #[derive(Clone, Debug)] @@ -22,6 +25,7 @@ pub enum CompleteCommand { Complete(CompleteArgs), } +/// Generally used via [`CompleteCommand`] #[derive(clap::Args)] #[command(arg_required_else_help = true)] #[command(group = clap::ArgGroup::new("complete").multiple(true).conflicts_with("register"))] diff --git a/clap_complete/src/dynamic/shells/shell.rs b/clap_complete/src/dynamic/shells/shell.rs index a9f48cee935..c36d2a23a41 100644 --- a/clap_complete/src/dynamic/shells/shell.rs +++ b/clap_complete/src/dynamic/shells/shell.rs @@ -4,7 +4,7 @@ use std::str::FromStr; use clap::builder::PossibleValue; use clap::ValueEnum; -/// Shell with auto-generated completion script available. +/// Completion support for built-in shells #[derive(Clone, Copy, Debug, Eq, Hash, PartialEq)] #[non_exhaustive] pub enum Shell {