Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
Browse files

Fixed a few documentation issues.

  • Loading branch information...
commit 341a114b906b45af3a3372664d046b7d147b16df 1 parent 16041ed
@jezdez jezdez authored toastdriven committed
View
6 docs/searchquery_api.rst
@@ -258,21 +258,21 @@ similar to the provided instance.
Adds highlighting to the search results.
``add_within``
-~~~~~~~~~~~~~~~~~
+~~~~~~~~~~~~~~
.. method:: SearchQuery.add_within(self, field, point_1, point_2):
Adds bounding box parameters to search query.
``add_dwithin``
-~~~~~~~~~~~~~~~~~
+~~~~~~~~~~~~~~~
.. method:: SearchQuery.add_dwithin(self, field, point, distance):
Adds radius-based parameters to search query.
``add_distance``
-~~~~~~~~~~~~~~~~~
+~~~~~~~~~~~~~~~~
.. method:: SearchQuery.add_distance(self, field, point):
View
18 docs/searchqueryset_api.rst
@@ -334,33 +334,33 @@ Example::
# Count document hits for authors that start with 'jo' within the index.
SearchQuerySet().filter(content='foo').query_facet('author', 'jo*')
-``query_facet``
-~~~~~~~~~~~~~~~
+``within``
+~~~~~~~~~~
.. method:: SearchQuerySet.within(self, field, point_1, point_2):
Spatial: Adds a bounding box search to the query.
-See the :ref:`spatial` docs for more information.
+See the :ref:`ref-spatial` docs for more information.
-``query_facet``
-~~~~~~~~~~~~~~~
+``dwithin``
+~~~~~~~~~~~
.. method:: SearchQuerySet.dwithin(self, field, point, distance):
Spatial: Adds a distance-based search to the query.
-See the :ref:`spatial` docs for more information.
+See the :ref:`ref-spatial` docs for more information.
-``query_facet``
-~~~~~~~~~~~~~~~
+``distance``
+~~~~~~~~~~~~
.. method:: SearchQuerySet.distance(self, field, point):
Spatial: Denotes results must have distance measurements from the
provided point.
-See the :ref:`spatial` docs for more information.
+See the :ref:`ref-spatial` docs for more information.
``narrow``
~~~~~~~~~~
View
22 docs/spatial.rst
@@ -43,19 +43,19 @@ For Elasticsearch, you'll need...
.. _Solr: http://lucene.apache.org/solr/
-====================== ====== =============== ======== ======== ========
+====================== ====== =============== ======== ======== ======
Lookup Type Solr Elasticsearch Whoosh Xapian Simple
-====================== ====== =============== ======== ======== ========
-:lookup:`within` X X
-:lookup:`dwithin` X X
+====================== ====== =============== ======== ======== ======
+`within` X X
+`dwithin` X X
`distance` X X
`order_by('distance')` X X
-:lookup:`polygon` X
+`polygon` X
+====================== ====== =============== ======== ======== ======
For more details, you can inspect http://wiki.apache.org/solr/SpatialSearch
or http://www.elasticsearch.org/guide/reference/query-dsl/geo-bounding-box-filter.html.
-
Geospatial Assumptions
======================
@@ -202,11 +202,11 @@ Querying
========
There are two types of geospatial queries you can run, ``within`` & ``dwithin``.
-Like their GeoDjango_ counterparts_, these methods focus on finding results
-within an area.
+Like their GeoDjango counterparts (within_ & dwithin_), these methods focus on
+finding results within an area.
-.. _GeoDjango: https://docs.djangoproject.com/en/dev/ref/contrib/gis/geoquerysets/#within
-.. _counterparts: https://docs.djangoproject.com/en/dev/ref/contrib/gis/geoquerysets/#dwithin
+.. _within: https://docs.djangoproject.com/en/dev/ref/contrib/gis/geoquerysets/#within
+.. _dwithin: https://docs.djangoproject.com/en/dev/ref/contrib/gis/geoquerysets/#dwithin
``within``
@@ -250,7 +250,7 @@ Examples::
``dwithin``
-----------
+-----------
.. method:: SearchQuerySet.dwithin(self, field, point, distance)
Please sign in to comment.
Something went wrong with that request. Please try again.