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

Merge pull request #2720 from epage/generate

Browse source 
docs(generate): Improve jumping off points
This commit is contained in:
Pavan Kumar Sunkara 2021-08-18 19:51:35 +01:00 committed by GitHub
commit 2fd26423e2
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
2 changed files with 20 additions and 3 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

13
clap_generate/README.md
View file

@ -1 +1,14 @@
# clap_generate
[![Crates.io](https://img.shields.io/crates/v/clap_generate?style=flat-square)](https://crates.io/crates/clap_generate)
[![Crates.io](https://img.shields.io/crates/d/clap_generate?style=flat-square)](https://crates.io/crates/clap_generate)
[![License](https://img.shields.io/badge/license-Apache%202.0-blue?style=flat-square)](https://github.com/clap-rs/clap/blob/master/LICENSE-APACHE)
[![License](https://img.shields.io/badge/license-MIT-blue?style=flat-square)](https://github.com/clap-rs/clap/blob/master/LICENSE-MIT)
Generates completions (and other things) for [`clap`](https://github.com/clap-rs/clap) based CLIs
* [Documentation][docs]
* [Questions & Discussions](https://github.com/clap-rs/clap/discussions)
* [Website](https://clap.rs/)
[docs]: https://docs.rs/clap_generate

10
clap_generate/src/lib.rs
View file

@ -5,7 +5,10 @@
// See the [LICENSE-APACHE](LICENSE-APACHE) and [LICENSE-MIT](LICENSE-MIT) files in this repository
// for more information.
//! Generates stuff for [`clap`](https://github.com/clap-rs/clap) based CLIs
//! Generates completions (and other things) for [`clap`](https://github.com/clap-rs/clap) based CLIs
//!
//! - For generating at compile-time, see [`generate_to`]
//! - For generating at runtime, see [`generate`]
#![doc(html_logo_url = "https://clap.rs/images/media/clap.png")]
#![doc(html_root_url = "https://docs.rs/clap_generate/3.0.0-beta.4")]
@ -36,9 +39,10 @@ pub use generators::Generator;
#[doc(inline)]
pub use shell::Shell;
/// Generate a file for a specified generator at compile time.
/// Generate a completions file for a specified shell at compile-time.
///
/// **NOTE:** to generate the file at compile time you must use a `build.rs` "Build Script"
/// **NOTE:** to generate the file at compile time you must use a `build.rs` "Build Script" or a
/// [`cargo-xtask`]](https://github.com/matklad/cargo-xtask)
///
/// # Examples
///