lib/penthouse/migrator.rb in penthouse-0.3.0 vs lib/penthouse/migrator.rb in penthouse-0.4.0

@@ -6,10 +6,11 @@
 
     extend self
 
     # Migrate to latest version
     # @param tenant_identifier [String, Symbol] the identifier for the tenant to switch to
+    # @return [void]
     def migrate(tenant_identifier)
       Penthouse.switch(tenant_identifier) do
         version = ENV["VERSION"] ? ENV["VERSION"].to_i : nil
 
         ActiveRecord::Migrator.migrate(ActiveRecord::Migrator.migrations_paths, version) do |migration|
@@ -19,18 +20,20 @@
     end
 
     # Migrate up/down to a specific version
     # @param tenant_identifier [String, Symbol] the identifier for the tenant to switch to
     # @param version [Integer] the version number to migrate up or down to
+    # @return [void]
     def run(direction, tenant_identifier, version)
       Penthouse.switch(tenant_identifier) do
         ActiveRecord::Migrator.run(direction, ActiveRecord::Migrator.migrations_paths, version)
       end
     end
 
     # rollback latest migration `step` number of times
     # @param tenant_identifier [String, Symbol] the identifier for the tenant to switch to
     # @param step [Integer] how many migrations to rollback by
+    # @return [void]
     def rollback(tenant_identifier, step = 1)
       Penthouse.switch(tenant_identifier) do
         ActiveRecord::Migrator.rollback(ActiveRecord::Migrator.migrations_paths, step)
       end
     end