diff --git a/clap_complete/src/env/mod.rs b/clap_complete/src/env/mod.rs index fb3499ca5dd..093ac67f4c9 100644 --- a/clap_complete/src/env/mod.rs +++ b/clap_complete/src/env/mod.rs @@ -68,6 +68,11 @@ pub use shells::*; /// - Performance: we don't need to general [`clap::Command`] twice or parse arguments /// - Flexibility: there is no concern over it interfering with other CLI logic /// +/// **Warning:** `stdout` should not be written to before [`CompleteEnv::complete`] has had a +/// chance to run. +/// +/// # Examples +/// /// ```rust /// # use clap_complete::CompleteEnv; /// fn cli() -> clap::Command {