Skip to content

Commit

Permalink
docs(complete): Add stdout warning to env
Browse files Browse the repository at this point in the history
  • Loading branch information
epage committed Aug 16, 2024
1 parent e46263a commit 3c69aaa
Showing 1 changed file with 5 additions and 0 deletions.
5 changes: 5 additions & 0 deletions clap_complete/src/env/mod.rs
Original file line number Diff line number Diff line change
Expand Up @@ -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 {
Expand Down

0 comments on commit 3c69aaa

Please sign in to comment.