Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP

Loading…

Fix querying documentation on faceting #67

Merged
merged 1 commit into from

2 participants

@davidjb

Update faceting documentation to reflect correct argument (changed 'fields' argument for facet_by to 'field')

@davidjb davidjb Fix querying documentation on faceting
Update faceting documentation to reflect correct argument (changed 'fields' argument for `facet_by` to 'field')
6710b51
@tow tow merged commit 502c851 into tow:master
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Commits on Jan 30, 2013
  1. @davidjb

    Fix querying documentation on faceting

    davidjb authored
    Update faceting documentation to reflect correct argument (changed 'fields' argument for `facet_by` to 'field')
This page is out of date. Refresh to see the latest.
Showing with 5 additions and 4 deletions.
  1. +5 −4 docs/queryingsolr.rst
View
9 docs/queryingsolr.rst
@@ -696,16 +696,17 @@ You can facet on more than one field at a time:
::
- si.query(...).facet_by(fields=["field1", "field2, ...])
+ si.query(...).facet_by(field=["field1", "field2, ...])
and the ``facet_fields`` dictionary will have more than one key.
-Solr supports a number of parameters to the faceting operation. All of the basic options
-are exposed through sunburnt:
+Solr supports a number of parameters to the faceting operation. These are described in detail
+at http://wiki.apache.org/solr/SimpleFacetParameters#Field_Value_Faceting_Parameters.
+All of the basic options are exposed through sunburnt:
::
- fields, prefix, sort, limit, offset, mincount, missing, method, enum.cache.minDf
+ field, prefix, sort, limit, offset, mincount, missing, method, enum.cache.minDf
All of these can be used as keyword arguments to the ``facet()`` call, except of course the
last one since it contains periods. To pass keyword arguments with periods in them, you
Something went wrong with that request. Please try again.