Skip to content

Commit b1cb09b

Browse files
committed
Better docstring for search_shards
1 parent edbf7ec commit b1cb09b

File tree

1 file changed

+4
-2
lines changed

1 file changed

+4
-2
lines changed

elasticsearch/client/__init__.py

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -536,8 +536,10 @@ def search_shards(self, index=None, doc_type=None, params=None):
536536
out issues or planning optimizations with routing and shard preferences.
537537
`<http://www.elastic.co/guide/en/elasticsearch/reference/current/search-shards.html>`_
538538
539-
:arg index: The name of the index
540-
:arg doc_type: The type of the document
539+
:arg index: A comma-separated list of index names to search; use `_all`
540+
or empty string to perform the operation on all indices
541+
:arg doc_type: A comma-separated list of document types to search; leave
542+
empty to perform the operation on all types
541543
:arg allow_no_indices: Whether to ignore if a wildcard indices
542544
expression resolves into no concrete indices. (This includes `_all`
543545
string or when no indices have been specified)

0 commit comments

Comments
 (0)