git.iko.soy/typeable/bloodhound
on master help sign in
Merge pull request #96 from MHova/fix-advancescroll-docs

Fix docs specifying an incorrect terminating condition

commitbfb4adf85af48159499dd9d4ea7f2cfb5b186fec authorChris Allen <cma@bitemyapp.com> dateWed 3 Feb 2016, 00:04 (11 years ago) parentafc592845efac7
2 files changed+3−4
compare with master
unifiedsplit
README.md+1−1 src/Database/Bloodhound/Client.hs+2−3
README.md+1−1
@@ -21,7 +21,7 @@ Endorsements
2121Version compatibility
2222---------------------
2323
24−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.
24+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.
2525
2626Current 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.
2727
src/Database/Bloodhound/Client.hs+2−3
@@ -680,9 +680,8 @@ scroll' (Just sid) = do
680680 Right SearchResult {..} -> return (hits searchHits, scrollId)
681681 Left _ -> return ([], Nothing)
682682
683−-- | Use the given scroll to fetch the next page of documents. If
684−-- there are still further pages, there will be a value in the
685−-- 'scrollId' field of the 'SearchResult'
683+-- | Use the given scroll to fetch the next page of documents. If there are no
684+-- further pages, 'SearchResult.searchHits.hits' will be '[]'.
686685advanceScroll
687686 :: ( FromJSON a
688687 , MonadBH m