lib/jiralicious/search.rb in jiralicious-0.2.0 vs lib/jiralicious/search.rb in jiralicious-0.2.1

@@ -1,6 +1,10 @@
 # encoding: utf-8
 module Jiralicious
+  ##
+  # Provides the interface to access the JQL search functionality.
+  # Uses the same syntax as Rest interface for JQL criteria.
+  #
   def search(jql, options = {})
     options[:start_at] ||= 0
     options[:max_results] ||= 50
     options[:fields] = [options[:fields]] if options[:fields].is_a? String
     options[:fields] ||= ["*navigable"]