Minor doc tweaks

mozilla · Aug 11, 2011 · 72c0b37 · 72c0b37
1 parent a14e1ba
commit 72c0b37
Show file tree

Hide file tree

Showing 3 changed files with 21 additions and 3 deletions.
diff --git a/.gitignore b/.gitignore
@@ -1,3 +1,4 @@
 build/
 dist/
 *.egg-info
+docs/_build/
diff --git a/docs/installation.rst b/docs/installation.rst
@@ -22,6 +22,14 @@ Installation
     so you don't have to
     have ElasticSearch running.
 
+.. data:: ES_DUMP_CURL
+
+    If set to a path all the requests that `ElasticUtils` makes will be dumped
+    into the designated file.
+
+    .. note:: Python does not write this file until the process is finished.
+
+
 .. data:: ES_HOSTS
 
     This is a list of hosts.  In development this will look like::

diff --git a/docs/queries.rst b/docs/queries.rst
@@ -6,9 +6,18 @@ ElasticUtils makes querying and filtering and collecting facets from
 ElasticSearch simple ::
 
 
-    q = (S(product='firefox').filter(version='4.0', platform='all')
-                             .facet('product', global_=True).facet('version')
-                             .facet('platform').facet('type'))
+    q = (S(model).filter(product='firefox')
+                 .filter(version='4.0', platform='all')
+                 .facet('product', global_=True).facet('version')
+                 .facet('platform').facet('type'))
+
+
+Where ``model`` is a Django-model.
+
+.. note::
+
+    If you're not using Django,  you can create stub-models.  See the tests for
+    more details.
 
 Search All
 ----------