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

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

diff --git a/lib/prune/plugins/agendav.rb b/lib/prune/plugins/agendav.rb
index 86a437bd699727a64f05ea38982ffe59fc53007f..f0f018381b7d0719a7eba1759b1a05fa6a11952a 100644 (file)
--- a/lib/prune/plugins/agendav.rb
+++ b/lib/prune/plugins/agendav.rb
@@ -3,6 +3,11 @@ require 'pg'
 require 'prune/prune_plugin'
 require 'rm/plugins/agendav'
 
+# Handle the pruning of Agendav users from its database. This class
+# doesn't need to do anything; by inheriting from {AgendavRm}, we get
+# its {AgendavRm#remove_user} method and that's all we need to prune.
+#
 class AgendavPrune < AgendavRm
+  # Needed for the magic includers <tt>run()</tt> method.
   include PrunePlugin
 end