Skip to content

Commit ce801b9

Browse files
authored
Include a reference to the shape of the migration files in the migrate macro documentation (launchbadge#1498)
1 parent df2d5c7 commit ce801b9

File tree

1 file changed

+2
-0
lines changed

1 file changed

+2
-0
lines changed

src/macros.rs

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -718,6 +718,8 @@ macro_rules! query_file_scalar_unchecked (
718718
/// unlike `include_str!()` which uses compiler internals to get the path of the file where it
719719
/// was invoked.
720720
///
721+
/// See [MigrationSource][crate::migrate::MigrationSource] for details on structure of the ./migrations directory.
722+
///
721723
/// ## Triggering Recompilation on Migration Changes
722724
/// In some cases when making changes to embedded migrations, such as adding a new migration without
723725
/// changing any Rust source files, you might find that `cargo build` doesn't actually do anything,

0 commit comments

Comments
 (0)