Skip to content

Commit f473a57

Browse files
committed
Add TomDoc documentation to the get_documents method
1 parent a9cd8d9 commit f473a57

File tree

1 file changed

+11
-0
lines changed

1 file changed

+11
-0
lines changed

lib/meilisearch/index.rb

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -63,6 +63,17 @@ def document(document_id, fields: nil)
6363
alias get_document document
6464
alias get_one_document document
6565

66+
67+
# Public: Retrieve documents from a index.
68+
#
69+
# options - The hash options used to refine the selection (default: {}):
70+
# :limit - Number of documents to return (optional).
71+
# :offset - Number of documents to skip (optional).
72+
# :fields - Array of document attributes to show (optional).
73+
# :filter - Filter queries by an attribute's value.
74+
# Available ONLY with Meilisearch v1.2 and newer (optional).
75+
#
76+
# Returns the documents results object.
6677
def documents(options = {})
6778
Utils.version_error_handler(__method__) do
6879
if options.key?(:filter)

0 commit comments

Comments
 (0)