Document everything with YARD and fix some bugs along the way.

[mailshears.git] / lib / prune / plugins / dovecot.rb

diff --git a/lib/prune/plugins/dovecot.rb b/lib/prune/plugins/dovecot.rb
index 7d346ac23b22adce05fe92b46716f7614abb9c47..9fbeb58f14170f3d56bf0edad78e39ed28ae1144 100644 (file)
--- a/lib/prune/plugins/dovecot.rb
+++ b/lib/prune/plugins/dovecot.rb
@@ -1,6 +1,11 @@
 require 'prune/prune_plugin'
 require 'rm/plugins/dovecot'
 
+# Handle the pruning of Dovecot users from its database. This class
+# doesn't need to do anything; by inheriting from {DovecotRm}, we get
+# its {DovecotRm#remove_user} method and that's all we need to prune.
+#
 class DovecotPrune < DovecotRm
+  # Needed for the magic includers <tt>run()</tt> method.
   include PrunePlugin
 end