From be1391b9ac38dd62eebf9d8cce41cc50bb9bc2d1 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Honza=20Kr=C3=A1l?= <honza.kral@gmail.com>
Date: Fri, 22 Aug 2014 16:06:58 -0700
Subject: [PATCH] Added better description of global parameters

Fixes #118
---
 docs/api.rst | 35 +++++++++++++++++++++++++++++------
 1 file changed, 29 insertions(+), 6 deletions(-)

diff --git a/docs/api.rst b/docs/api.rst
index 70bcb695..1d4d0864 100644
--- a/docs/api.rst
+++ b/docs/api.rst
@@ -9,6 +9,21 @@ that the code makes distinction between positional and keyword arguments; we,
 however, recommend that people **use keyword arguments for all calls for
 consistency and safety**.
 
+.. note::
+
+    for compatibility with the Python ecosystem we use ``from_`` instead of
+    ``from`` and ``doc_type`` instead of ``type`` as parameter names.
+
+
+Global options
+--------------
+
+Some parameters are added by the client itself and can be used in all API
+calls.
+
+Ignore
+~~~~~~
+
 An API call is considered successful (and will return a response) if
 elasticsearch returns a 2XX response. Otherwise an instance of
 :class:`~elasticsearch.TransportError` (or a more specific subclass) will be
@@ -26,17 +41,25 @@ them::
     # ignore 404 and 400
     es.indices.delete(index='test-index', ignore=[400, 404])
 
-You can also specify ``request_timeout`` (float) as part of any API call, this
-value will get passed to the ``perform_request`` method of the connection
-class::
+
+Timeout
+~~~~~~~
+
+Global timeout can be set when constructing the client (see
+:class:`~elasticsearch.Connection`'s ``timeout`` parameter) or on a per-request
+basis using ``request_timeout`` (float value in seconds) as part of any API
+call, this value will get passed to the ``perform_request`` method of the
+connection class::
 
     # only wait for 1 second, regardless of the client's default
     es.cluster.health(wait_for_status='yellow', request_timeout=1)
 
 .. note::
-   
-    for compatibility with the Python ecosystem we use ``from_`` instead of
-    ``from`` and ``doc_type`` instead of ``type`` as parameter names.
+
+    Some API calls also accept a ``timeout`` parameter that is passed to
+    Elasticsearch server. This timeout is internal and doesn't guarantee that the
+    request will end in the specified time.
+
 
 .. py:module:: elasticsearch