File tree 4 files changed +21
-5
lines changed
4 files changed +21
-5
lines changed Original file line number Diff line number Diff line change 8
8
//! [`Shell`] is a convenience `enum` for an argument value type that implements `Generator`
9
9
//! for each natively-supported shell type.
10
10
//!
11
+ //! To customize completions, see
12
+ //! - [`ValueHint`]
13
+ //! - [`ValueEnum`][clap::ValueEnum]
14
+ //!
11
15
//! ## Example
12
16
//!
13
17
//! ```rust,no_run
Original file line number Diff line number Diff line change @@ -46,6 +46,11 @@ pub use shells::*;
46
46
47
47
/// A completion subcommand to add to your CLI
48
48
///
49
+ /// To customize completions, see
50
+ /// - [`ValueHint`][crate::ValueHint]
51
+ /// - [`ValueEnum`][clap::ValueEnum]
52
+ /// - [`ArgValueCompleter`][crate::ArgValueCompleter]
53
+ ///
49
54
/// **Warning:** `stdout` should not be written to before [`CompleteCommand::complete`] has had a
50
55
/// chance to run.
51
56
///
@@ -113,6 +118,11 @@ impl CompleteCommand {
113
118
114
119
/// A completion subcommand to add to your CLI
115
120
///
121
+ /// To customize completions, see
122
+ /// - [`ValueHint`][crate::ValueHint]
123
+ /// - [`ValueEnum`][clap::ValueEnum]
124
+ /// - [`ArgValueCompleter`][crate::ArgValueCompleter]
125
+ ///
116
126
/// **Warning:** `stdout` should not be written to before [`CompleteArgs::complete`] has had a
117
127
/// chance to run.
118
128
///
Original file line number Diff line number Diff line change 1
- //! Complete commands within shells
1
+ //! `clap`-native completion system
2
2
//!
3
- //! To customize completions, see
4
- //! - [`ValueHint`][crate::ValueHint]
5
- //! - [`ValueEnum`][clap::ValueEnum]
6
- //! - [`ArgValueCompleter`]
3
+ //! See [`complete()`]
7
4
8
5
mod candidate;
9
6
mod complete;
Original file line number Diff line number Diff line change 16
16
//! }
17
17
//! ```
18
18
//!
19
+ //! To customize completions, see
20
+ //! - [`ValueHint`][crate::ValueHint]
21
+ //! - [`ValueEnum`][clap::ValueEnum]
22
+ //! - [`ArgValueCompleter`][crate::ArgValueCompleter]
23
+ //!
19
24
//! To source your completions:
20
25
//!
21
26
//! **WARNING:** We recommend re-sourcing your completions on upgrade.
You can’t perform that action at this time.
0 commit comments