Merge pull request #96 from MHova/fix-advancescroll-docs

Fix docs specifying an incorrect terminating condition
This commit is contained in:
Chris Allen 2016-02-03 00:04:45 -06:00
commit bfb4adf85a
2 changed files with 3 additions and 4 deletions

View File

@ -21,7 +21,7 @@ Endorsements
Version compatibility
---------------------
Elasticsearch \>= 1.0 is recommended. Bloodhound mostly works with 0.9.x, but I don't recommend it if you expect everything to work. As of Bloodhound 0.3 all \>=1.0 versions of Elasticsearch work.
Elasticsearch \>=1.0 && \<2.0 is recommended. Bloodhound mostly works with 0.9.x, but I don't recommend it if you expect everything to work. As of Bloodhound 0.3 all \>=1.0 && \<2.0 versions of Elasticsearch work. Some (or even most?) features will work with versions \>=2.0, but it is not officially supported yet.
Current versions we test against are 1.0.3, 1.1.2, 1.2.3, 1.3.2, and 1.4.0. We also check that GHC 7.6 and 7.8 both build and pass tests. See our [TravisCI](https://travis-ci.org/bitemyapp/bloodhound) to learn more.

View File

@ -680,9 +680,8 @@ scroll' (Just sid) = do
Right SearchResult {..} -> return (hits searchHits, scrollId)
Left _ -> return ([], Nothing)
-- | Use the given scroll to fetch the next page of documents. If
-- there are still further pages, there will be a value in the
-- 'scrollId' field of the 'SearchResult'
-- | Use the given scroll to fetch the next page of documents. If there are no
-- further pages, 'SearchResult.searchHits.hits' will be '[]'.
advanceScroll
:: ( FromJSON a
, MonadBH m