Better docstring for search_shards

This commit is contained in:
Honza Král
2015-09-13 21:06:22 +02:00
parent edbf7ec545
commit b1cb09ba8f
+4 -2
View File
@@ -536,8 +536,10 @@ class Elasticsearch(object):
out issues or planning optimizations with routing and shard preferences. out issues or planning optimizations with routing and shard preferences.
`<http://www.elastic.co/guide/en/elasticsearch/reference/current/search-shards.html>`_ `<http://www.elastic.co/guide/en/elasticsearch/reference/current/search-shards.html>`_
:arg index: The name of the index :arg index: A comma-separated list of index names to search; use `_all`
:arg doc_type: The type of the document or empty string to perform the operation on all indices
:arg doc_type: A comma-separated list of document types to search; leave
empty to perform the operation on all types
:arg allow_no_indices: Whether to ignore if a wildcard indices :arg allow_no_indices: Whether to ignore if a wildcard indices
expression resolves into no concrete indices. (This includes `_all` expression resolves into no concrete indices. (This includes `_all`
string or when no indices have been specified) string or when no indices have been specified)