X-Git-Url: http://gitweb.michael.orlitzky.com/?p=mailshears.git;a=blobdiff_plain;f=lib%2Fmv%2Fmv_runner.rb;h=fe44e5c244d3fe4cff66f140bb4d684ca903364a;hp=0e5e909e268944c25f2003e82eceb84bcc5b7bda;hb=df4e02ebf6a4e28a58abcb298a4442a245ad0b15;hpb=a731b98f97194b8882c42d3c2b27de75f60d6b05

diff --git a/lib/mv/mv_runner.rb b/lib/mv/mv_runner.rb
index 0e5e909..fe44e5c 100644
--- a/lib/mv/mv_runner.rb
+++ b/lib/mv/mv_runner.rb
@@ -2,9 +2,23 @@ require 'common/domain'
 require 'common/errors'
 require 'common/runner'
 
+# Perform the moving (renaming) of users/domains using {MvPlugin}s.
+#
 class MvRunner
   include Runner
 
+  # Run *plugin* to move the user *src* to *dst*. The method
+  # signature includes the unused *cfg* for consistency with the
+  # runners that do need a {Configuration}.
+  #
+  # @param cfg [Configuration] unused.
+  #
+  # @param plugin [Class] plugin class that will perform the move.
+  #
+  # @param src [User] the source user to be moved.
+  #
+  # @param dst [User] the destination user being moved to.
+  #
   def run(cfg, plugin, src, dst)
 
     if src.is_a?(Domain) or dst.is_a?(Domain) then