Clarify the interaction between full_state and timeout.

This commit is contained in:
Richard van der Hoff 2015-10-26 19:20:58 +00:00
parent 13eddd456f
commit ece42688d0

View file

@ -49,7 +49,9 @@ paths:
If this is set to ``true``, then all state events will be returned,
even if ``since`` is non-empty. The timeline will still be limited
by the ``since`` parameter.
by the ``since`` parameter. In this case, the ``timeout`` parameter
will be ignored and the query will return immediately, possibly with
an empty timeline.
If ``false``, and ``since`` is non-empty, only state which has
changed since the point indicated by ``since`` will be returned.