Skip to content

Commit 3c69aaa

Browse files
committed
docs(complete): Add stdout warning to env
1 parent e46263a commit 3c69aaa

File tree

1 file changed

+5
-0
lines changed

1 file changed

+5
-0
lines changed

clap_complete/src/env/mod.rs

+5
Original file line numberDiff line numberDiff line change
@@ -68,6 +68,11 @@ pub use shells::*;
6868
/// - Performance: we don't need to general [`clap::Command`] twice or parse arguments
6969
/// - Flexibility: there is no concern over it interfering with other CLI logic
7070
///
71+
/// **Warning:** `stdout` should not be written to before [`CompleteEnv::complete`] has had a
72+
/// chance to run.
73+
///
74+
/// # Examples
75+
///
7176
/// ```rust
7277
/// # use clap_complete::CompleteEnv;
7378
/// fn cli() -> clap::Command {

0 commit comments

Comments
 (0)