From eb59b8e9d1ac096865bf433c803b69d1e25c9419 Mon Sep 17 00:00:00 2001 From: Erik Johnston Date: Fri, 16 Oct 2015 10:16:40 +0100 Subject: [PATCH] Mention count --- specification/modules/search.rst | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/specification/modules/search.rst b/specification/modules/search.rst index 493c2b7c2..03d2475fb 100644 --- a/specification/modules/search.rst +++ b/specification/modules/search.rst @@ -35,6 +35,10 @@ The search will *not* include rooms that are end to end encrypted. The results include a ``rank`` key that can be used to sort the results by revelancy. The higher the ``rank`` the more relevant the result is. +The value of ``count`` may not match the number of results. For example due to +the search query matching 1000s of results and the server truncating the +response. + Security considerations ----------------------- The server must only return results that the user has permission to see.