mirror of
https://github.com/clap-rs/clap
synced 2024-11-10 06:44:16 +00:00
docs(complete): Redistribute dynamic's documentation
This commit is contained in:
parent
de723aaf8a
commit
e46263a048
4 changed files with 21 additions and 5 deletions
|
@ -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
|
||||
|
|
|
@ -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.
|
||||
///
|
||||
|
|
|
@ -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;
|
||||
|
|
5
clap_complete/src/env/mod.rs
vendored
5
clap_complete/src/env/mod.rs
vendored
|
@ -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.
|
||||
|
|
Loading…
Reference in a new issue