Mention config.background_migrations.migrations_module in the initi…

…alizer template
fatkodima · Jan 17, 2024 · 22629cc · 22629cc
1 parent aa39e66
commit 22629cc
Show file tree

Hide file tree

Showing 2 changed files with 5 additions and 1 deletion.
diff --git a/lib/generators/online_migrations/templates/initializer.rb.tt b/lib/generators/online_migrations/templates/initializer.rb.tt
@@ -78,6 +78,10 @@ OnlineMigrations.configure do |config|
   # end
 
   # ==> Background migrations configuration
+
+  # The module in which background migrations will be placed.
+  # config.background_migrations.migrations_module = "OnlineMigrations::BackgroundMigrations"
+
   # The number of rows to process in a single background migration run.
   # config.background_migrations.batch_size = 20_000
 

diff --git a/lib/online_migrations/background_migrations/config.rb b/lib/online_migrations/background_migrations/config.rb
@@ -4,7 +4,7 @@ module OnlineMigrations
   module BackgroundMigrations
     # Class representing configuration options for background migrations.
     class Config
-      # The module to namespace background migrations in
+      # The module in which background migrations will be placed
       # @return [String] defaults to "OnlineMigrations::BackgroundMigrations"
       attr_accessor :migrations_module