Skip to content

Commit

Permalink
docs(Macros): adds a warning about changing values in Cargo.toml not …
Browse files Browse the repository at this point in the history
…triggering a rebuild automatically

Closes #838
  • Loading branch information
kbknapp committed Feb 3, 2017
1 parent ce4534c commit 3689485
Showing 1 changed file with 7 additions and 0 deletions.
7 changes: 7 additions & 0 deletions src/macros.rs
Original file line number Diff line number Diff line change
Expand Up @@ -498,6 +498,13 @@ macro_rules! crate_name {
/// Provided separator is for the [`crate_authors!`](macro.crate_authors.html) macro,
/// refer to the documentation therefor.
///
/// **NOTE:** Changing the values in your `Cargo.toml` does not trigger a re-build automatically,
/// and therefore won't change the generated output until you recompile.
///
/// **Pro Tip:** In some cases you can "trick" the compiler into triggering a rebuild when your
/// `Cargo.toml` is changed by including this in your `src/main.rs` file
/// `include_str!("../Cargo.toml");`
///
/// # Examples
///
/// ```no_run
Expand Down

0 comments on commit 3689485

Please sign in to comment.