Fixed documentation except glossary.rst

docs/guide/appendix/clients.rst

@@ -1,14 +1,14 @@
-.. _es-guide-appendix-clients:
-
-=======
-Clients
-=======
-
+.. _es-guide-appendix-clients:
+
+=======
+Clients
+=======
+
 ---
 ---
 
 Clients
---------
+--------
 
 * `ElasticSearch.pm <http://github.com/clintongormley/ElasticSearch.pm>`_:  Perl client.
 * `pyes <http://github.com/aparo/pyes>`_:  Python client.
@@ -18,14 +18,14 @@ Clients
 * `em-elasticsearch <http://github.com/ichverstehe/em-elasticsearch>`_:  elasticsearch library for eventmachine.
 *  `elastic_searchable <https://github.com/wireframe/elastic_searchable/>`_:  Ruby client + Rails integration.
 * `erlastic_search <http://github.com/tsloughter/erlastic_search>`_:  Erlang client.
-* `elasticsearch <http://github.com/nervetattoo/elasticsearch>`_  `_  PHP client.
+* `elasticsearch <http://github.com/nervetattoo/elasticsearch>`_ :  PHP client.
 * `NEST <https://github.com/Mpdreamz/NEST>`_:  .NET client.
 * `ElasticSearch.NET <https://github.com/medcl/ElasticSearch.Net>`_:  .NET client.
 * `pyelasticsearch <http://github.com/rhec/pyelasticsearch>`_:  Python client.
 * `Elastisch <http://github.com/clojurewerkz/elastisch>`_:  Clojure client.
 
 Integrations
--------------
+-------------
 
 * `Grails <http://grails.org/plugin/elasticsearch>`_:  ElasticSearch Grails plugin.
 * `escargot <https://github.com/angelf/escargot>`_:  ElasticSearch connector for Rails (WIP).
@@ -41,7 +41,7 @@ Integrations
 * `Jetty <https://github.com/sonian/elasticsearch-jetty>`_:  Jetty HTTP Transport
 
 Misc
------
+-----
 
 * `Puppet <https://github.com/visibiz/puppet-elasticsearch>`_:  elasticsearch puppet module.
 * `Chef <http://community.opscode.com/cookbooks/elasticsearch>`_:  elasticsearch chef recipe.
@@ -50,13 +50,13 @@ Misc
 * `Scrutineer <https://github.com/Aconex/scrutineer>`_:  A high performance consistency checker to compare what you've indexed with your source of truth content (e.g. DB)
 
 Front Ends
------------
+-----------
 
 * `elasticsearch-head <https://github.com/mobz/elasticsearch-head>`_:  A web front end for an elastic search cluster.
 * `bigdesk <https://github.com/lukas-vlcek/bigdesk>`_:  Live charts and statistics for elasticsearch cluster.
 
 GitHub
--------
+-------
+
+GitHub is a place where a lot of development is done around *elasticsearch*, here is a simple search for `repos <https://github.com/search?q=elasticsearch&type=Repositories>`_.
 
-GitHub is a place where a lot of development is done around *elasticsearch*, here is a simple search for `repos <https://github.com/search?q=elasticsearch&type=Repositories>`_.  
-

docs/guide/reference/api/index_.rst

@@ -188,7 +188,7 @@ A document can be indexed with a **timestamp** associated with it. The **timesta
     }'
 
 
-If the **timestamp** value is not provided externally or in the **_source**, the **timestamp** will be automatically set to the date the document was processed by the indexing chain. More information can be found on the :ref:`_timestamp mapping page <es-guide-reference-mapping-timestamp-field>`.  
+If the **timestamp** value is not provided externally or in the **_source**, the **timestamp** will be automatically set to the date the document was processed by the indexing chain. More information can be found on the :ref:`_timestamp mapping page <es-guide-reference-mapping-timestamp-field>`.
 
 TTL
 ===
@@ -221,7 +221,7 @@ A document can be indexed with a **ttl** (time to live) associated with it. Expi
     }'
 
 
-More information can be found on the :ref:`_ttl mapping page <es-guide-reference-api-mapping-ttl-field>`.  
+More information can be found on the :ref:`_ttl mapping page <es-guide-reference-mapping-ttl-field>`.
 Percolate
 =========
 

docs/guide/reference/api/search/facets/index.rst

@@ -74,7 +74,7 @@ That's because the primary purpose of facets is to enable `_faceted navigation_
 
 !/guide/images/linkedin-faceted-search.png(Faceted Search at LinkedIn)!
 
-Facets can be used, however, for other purposes: computing histograms, statistical aggregations, and more. See the article about :ref:`data visualization <es-guide-reference-api-search-facets-blog-2011-05-13-data-visualization-with-elasticsearch-and-protovis>`  on the ElasticSearch's blog for inspiration.
+Facets can be used, however, for other purposes: computing histograms, statistical aggregations, and more.
 
 Scope
 -----
@@ -91,7 +91,7 @@ As we have already mentioned, facet computation is restricted to the scope of th
                 "global" : true
             }
         }
-    }    
+    }
 
 
 There's one **important distinction** to keep in mind. While search **queries** restrict both the returned documents and facet counts, search **filters** restrict only returned documents &mdash; but **not** facet counts.
@@ -117,7 +117,7 @@ All facets can be configured with an additional filter (explained in the :ref:`Q
                 }
             }
         }
-    }    
+    }
 
 
 Note that this is different from a facet of the :ref:`filter <es-guide-reference-api-search-facets-filter-facet>`  type.

docs/guide/reference/groovy-api/delete.rst

@@ -4,7 +4,7 @@
 Delete
 ======
 
-The delete API is very similar to the :ref:`Java delete API <es-guide-reference-groovy-java-api-delete>`,  here is an example:
+The delete API is very similar to the :ref:`Java delete API <es-guide-reference-java-api-delete>`,  here is an example:
 
 
 .. code-block:: js

docs/guide/reference/groovy-api/get.rst

@@ -4,7 +4,7 @@
 Get
 ===
 
-The get API is very similar to the :ref:`Java get API <es-guide-reference-groovy-java-api-get>`.  The main benefit of using groovy is handling the source content. It can be automatically converted to a **Map** which means using Groovy to navigate it is simple:
+The get API is very similar to the :ref:`Java get API <es-guide-reference-java-api-get>`.  The main benefit of using groovy is handling the source content. It can be automatically converted to a **Map** which means using Groovy to navigate it is simple:
 
 
 .. code-block:: js
@@ -14,6 +14,6 @@ The get API is very similar to the :ref:`Java get API <es-guide-reference-groovy
         type "type1"
         id "1"
     }
-    
+
     println "Result of field2: $getF.response.source.complex.field2"
 

docs/guide/reference/groovy-api/index.rst

@@ -8,12 +8,12 @@ Groovy Api
 This section describes the `Groovy <http://groovy.codehaus.org/>`_  API elasticsearch provides. All of elasticsearch APIs are executed using a :ref:`GClient <es-guide-reference-groovy-api-client>`,  and are completely asynchronous in nature (either accepts a listener, or return a future).
 
 
-The Groovy API is a wrapper on top of the :ref:`Java API <es-guide-reference-groovy-java-api>`  exposing it in a groovier manner. The execution options for each API follow a similar manner and covered in :ref:`the anatomy of a Groovy API <es-guide-reference-groovy-api-anatomy>`.  
+The Groovy API is a wrapper on top of the :ref:`Java API <es-guide-reference-java-api>`  exposing it in a groovier manner. The execution options for each API follow a similar manner and covered in :ref:`the anatomy of a Groovy API <es-guide-reference-groovy-api-anatomy>`.
 
 Maven Repository
 ----------------
 
-elasticsearch is hosted on `Sonatype <http://www.sonatype.org/>`_,  with both a `releases repo <http://oss.sonatype.org/content/repositories/releases/>`_  and a `snapshots repo <http://oss.sonatype.org/content/repositories/snapshots>`_.  
+elasticsearch is hosted on `Sonatype <http://www.sonatype.org/>`_,  with both a `releases repo <http://oss.sonatype.org/content/repositories/releases/>`_  and a `snapshots repo <http://oss.sonatype.org/content/repositories/snapshots>`_.
 
 
 .. toctree::
@@ -25,4 +25,4 @@ elasticsearch is hosted on `Sonatype <http://www.sonatype.org/>`_,  with both a
     delete
     get
     index_
-    search
+    search

docs/guide/reference/groovy-api/index_.rst

@@ -4,7 +4,7 @@
 Index_
 ======
 
-The index API is very similar to the :ref:`Java index API <es-guide-reference-groovy-java-api-index_>`.  The Groovy extension to it is the ability to provide the indexed source using a closure. For example:
+The index API is very similar to the :ref:`Java index API <es-guide-reference-java-api-index_>`.  The Groovy extension to it is the ability to provide the indexed source using a closure. For example:
 
 
 .. code-block:: js

docs/guide/reference/groovy-api/search.rst

@@ -4,7 +4,7 @@
 Search
 ======
 
-The search API is very similar to the :ref:`Java search API <es-guide-reference-groovy-java-api-search>`.  The Groovy extension allows to provide the search source to execute as a **Closure** including the query itself (similar to GORM criteria builder):
+The search API is very similar to the :ref:`Java search API <es-guide-reference-java-api-search>`.  The Groovy extension allows to provide the search source to execute as a **Closure** including the query itself (similar to GORM criteria builder):
 
 
 .. code-block:: js
@@ -18,8 +18,8 @@ The search API is very similar to the :ref:`Java search API <es-guide-reference-
             }
         }
     }
-    
-    search.response.hits.each {SearchHit hit -> 
+
+    search.response.hits.each {SearchHit hit ->
         println "Got hit $hit.id from $hit.index/$hit.type"
     }
 
@@ -32,8 +32,8 @@ It can also be execute using the "Java API" while still using a closure for the
     def search = node.client.prepareSearch("test").setQuery({
             term(test: "value")
     }).gexecute();
-    
-    search.response.hits.each {SearchHit hit -> 
+
+    search.response.hits.each {SearchHit hit ->
         println "Got hit $hit.id from $hit.index/$hit.type"
     }
 

docs/guide/reference/index-modules/index.rst

@@ -1,5 +1,5 @@
 .. _es-guide-reference-index-modules-index:
-.. _es-guide-reference-index-module:
+.. _es-guide-reference-index-modules:
 
 =============
 Index Modules
@@ -15,12 +15,12 @@ There are specific index level settings that are not associated with any specifi
 
 
 ===========================  ================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================
- Setting                      Description                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    
+ Setting                      Description
 ===========================  ================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================
-index.compound_format        Should the compound file format be used (boolean setting). If not set, controlled by the actually store used, this is because the compound format was created to reduce the number of open file handles when using file based storage. By default, it is set to **false** for better performance (really applicable for file system based index storage), but, requires adapting the max open file handles.                                                                                                                     
-index.term_index_interval    Set the interval between indexed terms.  Large values cause less memory to be used by a reader / searcher, but slow random-access to terms. Small values cause more memory to be used by a reader / searcher, and speed random-access to terms. Defaults to **128**.                                                                                                                                                                                                                                                            
-index.term_index_divisor     Subsamples which indexed terms are loaded into RAM. This has the same effect as **index.term_index_interval** except that setting must be done at indexing time while this setting can be set per reader / searcher.  When set to N, then one in every N*termIndexInterval terms in the index is loaded into memory.  By setting this to a value > 1 you can reduce memory usage, at the expense of higher latency when loading a TermInfo.  The default value is 1.  Set this to -1 to skip loading the terms index entirely.  
-index.refresh_interval       A time setting controlling how often the refresh operation will be executed. Defaults to **1s**. Can be set to **-1** in order to disable it.                                                                                                                                                                                                                                                                                                                                                                                   
+index.compound_format        Should the compound file format be used (boolean setting). If not set, controlled by the actually store used, this is because the compound format was created to reduce the number of open file handles when using file based storage. By default, it is set to **false** for better performance (really applicable for file system based index storage), but, requires adapting the max open file handles.
+index.term_index_interval    Set the interval between indexed terms.  Large values cause less memory to be used by a reader / searcher, but slow random-access to terms. Small values cause more memory to be used by a reader / searcher, and speed random-access to terms. Defaults to **128**.
+index.term_index_divisor     Subsamples which indexed terms are loaded into RAM. This has the same effect as **index.term_index_interval** except that setting must be done at indexing time while this setting can be set per reader / searcher.  When set to N, then one in every N*termIndexInterval terms in the index is loaded into memory.  By setting this to a value > 1 you can reduce memory usage, at the expense of higher latency when loading a TermInfo.  The default value is 1.  Set this to -1 to skip loading the terms index entirely.
+index.refresh_interval       A time setting controlling how often the refresh operation will be executed. Defaults to **1s**. Can be set to **-1** in order to disable it.
 ===========================  ================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================
 
 .. toctree::
@@ -34,4 +34,3 @@ index.refresh_interval       A time setting controlling how often the refresh op
     slowlog
     store
     translog
-

pyes/connection.py

@@ -68,36 +68,26 @@ def connect(servers=None, framed_transport=False, timeout=None,
     Failing servers are kept on a separate list and eventually retried, no
     sooner than `retry_time` seconds after failure.
 
-    Parameters
-    ----------
-    servers : [server]
-              List of ES servers with format: "hostname:port"
+    :keyword servers: [server]
+                      List of ES servers with format: "hostname:port"
+                      Default: [("127.0.0.1",9500)]
 
-              Default: [("127.0.0.1",9500)]
-    framed_transport: bool
-              If True, use a TFramedTransport instead of a TBufferedTransport
-    timeout: float
-              Timeout in seconds (e.g. 0.5)
+    :keyword framed_transport: If True, use a TFramedTransport instead of a TBufferedTransport
 
-              Default: None (it will stall forever)
-    retry_time: float
-              Minimum time in seconds until a failed server is reinstated. (e.g. 0.5)
+    :keyword timeout: Timeout in seconds (e.g. 0.5)
+                      Default: None (it will stall forever)
 
-              Default: 60
-    recycle: float
-              Max time in seconds before an open connection is closed and returned to the pool.
+    :keyword retry_time: Minimum time in seconds until a failed server is reinstated. (e.g. 0.5)
+                         Default: 60
 
-              Default: None (Never recycle)
+    :keyword recycle:  Max time in seconds before an open connection is closed and returned to the pool.
+                       Default: None (Never recycle)
 
-    max_retries: int
-              Max retry time on connection down
+    :keyword max_retries: Max retry time on connection down
 
-    round_robin: bool
-              *DEPRECATED*
+    :keyword round_robin: *DEPRECATED*
 
-    Returns
-    -------
-    ES client
+    :return ES client
     """
 
     if servers is None: