Add TomDoc documentation to the get_documents method

meilisearch · May 20, 2023 · 20c0bfd · 20c0bfd
1 parent 87010f7
commit 20c0bfd
Showing 1 changed file with 11 additions and 0 deletions.
diff --git a/lib/meilisearch/index.rb b/lib/meilisearch/index.rb
@@ -63,6 +63,17 @@ def document(document_id, fields: nil)
     alias get_document document
     alias get_one_document document
 
+
+    # Public: Retrieve documents from a index.
+    #
+    # options - The hash options used to refine the selection (default: {}):
+    #           :limit  - Number of documents to return (optional).
+    #           :offset - Number of documents to skip (optional).
+    #           :fields - Array of document attributes to show (optional).
+    #           :filter - Filter queries by an attribute's value. 
+    #                     Available ONLY with Meilisearch v1.2 and newer (optional).
+    #
+    # Returns the documents results object.
     def documents(options = {})
       Utils.version_error_handler(__method__) do
         if options.key?(:filter)