Document everything with YARD and fix some bugs along the way.
[mailshears.git] / lib / prune / plugins / davical.rb
index f7f4b39cf64d5c0ca86d32fcf542738f1ecbc2a8..743356d039778d22322f22a8930f7f0672a0791d 100644 (file)
@@ -3,6 +3,11 @@ require 'pg'
 require 'prune/prune_plugin'
 require 'rm/plugins/davical'
 
+# Handle the pruning of DAViCal users from its database. This class
+# doesn't need to do anything; by inheriting from {DavicalRm}, we get
+# its {DavicalRm#remove_user} method and that's all we need to prune.
+#
 class DavicalPrune < DavicalRm
+  # Needed for the magic includers <tt>run()</tt> method.
   include PrunePlugin
 end