Document that clients must leave before forgetting rooms

Fixes https://github.com/matrix-org/matrix-doc/issues/1011
2018-07-04 15:31:23 -06:00 · 2018-07-04 15:31:23 -06:00 · 9e796192e4
commit 9e796192e4
parent 442ad99727
1 changed files with 2 additions and 2 deletions
--- a/api/client-server/leaving.yaml
+++ b/api/client-server/leaving.yaml
@ -78,8 +78,8 @@ paths:
        for this room. If all users on a homeserver forget a room, the room is
        eligible for deletion from that homeserver.

-        If the user is currently joined to the room, they will implicitly leave
-        the room as part of this API call.
+        If the user is currently joined to the room, they must leave the room
+        before calling this API.
      operationId: forgetRoom
      security:
        - accessToken: []