Mention rank

9 years ago · a6cb2e4339
parent 24e36adbe3
commit a6cb2e4339
1 changed files with 3 additions and 0 deletions
--- a/specification/modules/search.rst
+++ b/specification/modules/search.rst
@ -32,6 +32,9 @@ The supported keys to search over are:

 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.
+
 Security considerations
 -----------------------
 The server must only return results that the user has permission to see.