Skip to content

Commit 112aea3

Browse files
committed
docs(Macros): adds a warning about changing values in Cargo.toml not triggering a rebuild automatically
Closes #838
1 parent a5e4a98 commit 112aea3

File tree

1 file changed

+7
-0
lines changed

1 file changed

+7
-0
lines changed

src/macros.rs

+7
Original file line numberDiff line numberDiff line change
@@ -498,6 +498,13 @@ macro_rules! crate_name {
498498
/// Provided separator is for the [`crate_authors!`](macro.crate_authors.html) macro,
499499
/// refer to the documentation therefor.
500500
///
501+
/// **NOTE:** Changing the values in your `Cargo.toml` does not trigger a re-build automatically,
502+
/// and therefore won't change the generated output until you recompile.
503+
///
504+
/// **Pro Tip:** In some cases you can "trick" the compiler into triggering a rebuild when your
505+
/// `Cargo.toml` is changed by including this in your `src/main.rs` file
506+
/// `include_str!("../Cargo.toml");`
507+
///
501508
/// # Examples
502509
///
503510
/// ```no_run

0 commit comments

Comments
 (0)