Update the version in mailshears.gemspec.

[mailshears.git] / lib / prune / prune_dummy_runner.rb

diff --git a/lib/prune/prune_dummy_runner.rb b/lib/prune/prune_dummy_runner.rb
index d488f7ea155c7a77633212aeee3776d844921bbe..f90c9d06c50f774eb61e41d3970770cc4b1893d9 100644 (file)
--- a/lib/prune/prune_dummy_runner.rb
+++ b/lib/prune/prune_dummy_runner.rb
@@ -2,9 +2,29 @@ require 'common/runner'
 require 'prune/plugins/postfixadmin'
 require 'rm/rm_dummy_runner'
 
+# Dummy implementation of a {PruneRunner}. Its <tt>run()</tt> method will
+# tell you what would have been pruned, but will not actually perform
+# the operation.
+#
 class PruneDummyRunner
   include Runner
 
+
+  # Pretend to prune unused domains and users. Some "what if"
+  # information will be output to stdout.
+  #
+  # The prune mode is the main application of the "dummy" runners,
+  # since it performs some computation outside of the plugins
+  # themselves. This lets the user know which users and domains would
+  # be removed and can help prevent mistakes or even find bugs in the
+  # prune code, if it looks like something will be removed that
+  # shouldn't be!
+  #
+  # @param cfg [Configuration] the configuration options to pass to
+  #   the *plugin* we're runnning.
+  #
+  # @param plugin [Class] plugin class that will do the pruning.
+  #
   def run(cfg, plugin)
     # We don't want to check the PostfixAdmin database against itself.
     return if plugin.class == PostfixadminPrune