From 72c0b37a4636b14a7746d7856d5a1f82f177f396 Mon Sep 17 00:00:00 2001
From: Dave Dash
Date: Thu, 11 Aug 2011 15:41:00 -0700
Subject: [PATCH] Minor doc tweaks
---
.gitignore | 1 +
docs/installation.rst | 8 ++++++++
docs/queries.rst | 15 ++++++++++++---
3 files changed, 21 insertions(+), 3 deletions(-)
diff --git a/.gitignore b/.gitignore
index 02bbf52..659d70f 100644
--- a/.gitignore
+++ b/.gitignore
@@ -1,3 +1,4 @@
build/
dist/
*.egg-info
+docs/_build/
diff --git a/docs/installation.rst b/docs/installation.rst
index 475d595..37462b6 100644
--- 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
index 771bfc1..b04a446 100644
--- 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
----------