Skip to content

Commit e46263a

Browse files
committed
docs(complete): Redistribute dynamic's documentation
1 parent de723aa commit e46263a

File tree

4 files changed

+21
-5
lines changed

4 files changed

+21
-5
lines changed

clap_complete/src/aot/mod.rs

+4
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,10 @@
88
//! [`Shell`] is a convenience `enum` for an argument value type that implements `Generator`
99
//! for each natively-supported shell type.
1010
//!
11+
//! To customize completions, see
12+
//! - [`ValueHint`]
13+
//! - [`ValueEnum`][clap::ValueEnum]
14+
//!
1115
//! ## Example
1216
//!
1317
//! ```rust,no_run

clap_complete/src/command/mod.rs

+10
Original file line numberDiff line numberDiff line change
@@ -46,6 +46,11 @@ pub use shells::*;
4646

4747
/// A completion subcommand to add to your CLI
4848
///
49+
/// To customize completions, see
50+
/// - [`ValueHint`][crate::ValueHint]
51+
/// - [`ValueEnum`][clap::ValueEnum]
52+
/// - [`ArgValueCompleter`][crate::ArgValueCompleter]
53+
///
4954
/// **Warning:** `stdout` should not be written to before [`CompleteCommand::complete`] has had a
5055
/// chance to run.
5156
///
@@ -113,6 +118,11 @@ impl CompleteCommand {
113118

114119
/// A completion subcommand to add to your CLI
115120
///
121+
/// To customize completions, see
122+
/// - [`ValueHint`][crate::ValueHint]
123+
/// - [`ValueEnum`][clap::ValueEnum]
124+
/// - [`ArgValueCompleter`][crate::ArgValueCompleter]
125+
///
116126
/// **Warning:** `stdout` should not be written to before [`CompleteArgs::complete`] has had a
117127
/// chance to run.
118128
///

clap_complete/src/dynamic/mod.rs

+2-5
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,6 @@
1-
//! Complete commands within shells
1+
//! `clap`-native completion system
22
//!
3-
//! To customize completions, see
4-
//! - [`ValueHint`][crate::ValueHint]
5-
//! - [`ValueEnum`][clap::ValueEnum]
6-
//! - [`ArgValueCompleter`]
3+
//! See [`complete()`]
74
85
mod candidate;
96
mod complete;

clap_complete/src/env/mod.rs

+5
Original file line numberDiff line numberDiff line change
@@ -16,6 +16,11 @@
1616
//! }
1717
//! ```
1818
//!
19+
//! To customize completions, see
20+
//! - [`ValueHint`][crate::ValueHint]
21+
//! - [`ValueEnum`][clap::ValueEnum]
22+
//! - [`ArgValueCompleter`][crate::ArgValueCompleter]
23+
//!
1924
//! To source your completions:
2025
//!
2126
//! **WARNING:** We recommend re-sourcing your completions on upgrade.

0 commit comments

Comments
 (0)