Document everything with YARD and fix some bugs along the way.
[mailshears.git] / lib / prune / plugins / postfixadmin.rb
index 395fb240cd47e96c6751fc163d762b9f9d8f7467..7059e07b16d8ecd7b5e634fd869513ada204c213 100644 (file)
@@ -1,10 +1,13 @@
 require 'prune/prune_plugin'
 require 'rm/plugins/postfixadmin'
 
-class PostfixadminPrune < PostfixadminRm
-  # We don't need the ability to remove "left over" users or
-  # domains, since "left over" is with respect to what's in
-  # PostfixAdmin. In other words, the other plugins check themselves
-  # against PostfixAdmin, it doesn't make sense to check PostfixAdmin
-  # against itself.
-end
+# This class does absolutely nothing except allow us to blindly
+# instantiate classes based on the mode name and configured plugins.
+#
+# We don't need the ability to remove "left over" Postfixadmin users
+# or domains, since "left over" is with respect to what's in
+# Postfixadmin itself. The other pruning plugins check themselves
+# against Postfixadmin -- it doesn't make sense to check Postfixadmin
+# against itself.
+#
+class PostfixadminPrune < PostfixadminRm; end