Mirrors/clap
2
0
Fork 0
mirror of https://github.com/clap-rs/clap synced 2024-11-10 06:44:16 +00:00
Code Issues Projects Releases Packages Wiki Activity

docs(complete): Clarify some panic conditions

Browse source
This commit is contained in:
Ed Page 2022-01-21 08:29:38 -06:00
parent b488aab46c
commit afb2a3dd05
1 changed files with 8 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

8
clap_complete/src/generator/mod.rs
View file

@ -14,6 +14,10 @@ use clap::App;
pub trait Generator {
/// Returns the file name that is created when this generator is called during compile time.
///
/// # Panics
///
/// May panic when called outside of the context of [`generate`] or [`generate_to`]
///
/// # Examples
///
/// ```
@ -34,6 +38,10 @@ pub trait Generator {
/// Generates output out of [`clap::App`](App).
///
/// # Panics
///
/// May panic when called outside of the context of [`generate`] or [`generate_to`]
///
/// # Examples
///
/// The following example generator displays the [`clap::App`](App)