Merge pull request #66 from rossta/recurrence_include_doc

Document Recurrence#include?
rossta · Nov 21, 2016 · 276e88c · 276e88c
2 parents 6f44f5e + 97ce2ac
commit 276e88c
Showing 1 changed file with 5 additions and 0 deletions.
diff --git a/lib/montrose/recurrence.rb b/lib/montrose/recurrence.rb
@@ -75,6 +75,11 @@ def inspect
       "#<#{self.class}:#{object_id.to_s(16)} #{to_h.inspect}>"
     end
 
+    # Return true/false if given timestamp equals a
+    # timestamp given by the recurrence
+    #
+    # @return [Boolean] timestamp is included in recurrence
+    #
     def include?(timestamp)
       event_enum.lazy.each do |event|
         return true if event == timestamp