Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

docs(generate): Improve jumping off points #2720

Merged
merged 2 commits into from
Aug 18, 2021
Merged

docs(generate): Improve jumping off points #2720

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
13a93ab
docs(generate): Improve jumping off points
epage Aug 18, 2021
f2586c9
docs: Point out alternatives to 'build.rs'
epage Aug 18, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 13 additions & 0 deletions clap_generate/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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 changes: 7 additions & 3 deletions clap_generate/src/lib.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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")]
Expand Down Expand Up @@ -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
///
Expand Down