index: add comments

commit 3a5aad641238a56a39a39653d506e32a5e113638
parent 20ae5a798231c8e56a671ff5215bf0dd302907a7
Author: Damien Leone <damien.leone@fensalir.fr>
Date:   Fri, 25 Jun 2010 18:39:46 +0200

index: add comments

Diffstat:

lib/sup/index.rb

++++

1 file changed, 4 insertions(+), 0 deletions(-)
diff --git a/lib/sup/index.rb b/lib/sup/index.rb
@@ -255,6 +255,10 @@ EOS
   end
 
   ## Yield each message matching query
+  ## The ignore_neg_terms parameter is used to display result even if
+  ## it contains "forbidden" labels such as :deleted, it is used in
+  ## Poll#poll_from when we need to get the location of a message that
+  ## may contain these labels
   def each_message query={}, ignore_neg_terms = true, &b
     each_id query, ignore_neg_terms do |id|
       yield build_message(id)

sup.git