Commit 246976d8d8fad530de17c6dd4e1785a53502317a

Authored by Andrew Kane
1 parent 9eccde8e

Better docs

Showing 1 changed file with 4 additions and 2 deletions   Show diff stats
README.md
... ... @@ -594,7 +594,7 @@ Product.search "apples", aggs: {store_id: {limit: 10}}
594 594 products = Product.search "chuck taylor", aggs: [:brand]
595 595 ```
596 596  
597   -2. Replace the `facets` method with `aggs` to get the results.
  597 +2. Replace the `facets` method with `aggs` for results.
598 598  
599 599 ```ruby
600 600 products.facets
... ... @@ -629,7 +629,9 @@ Product.search "apples", aggs: {store_id: {limit: 10}}
629 629 }
630 630 ```
631 631  
632   -3. By default, where conditions apply - equivalent to `smart_facets: true`. You can control this with `smart_aggs: false`.
  632 + Update your application to handle this.
  633 +
  634 +3. By default, `where` conditions apply to aggregations. This is equivalent to `smart_facets: true`. If you have `smart_facets: true`, you can remove it. If this is not desired, set `smart_aggs: false`.
633 635  
634 636 ### Highlight
635 637  
... ...