Skip to content

Commit 48d4e95

Browse files
authored
Merge pull request #2817 from aaronraimist/room-v1
Improve wording of room version 1 warnings
2 parents 62cfc8c + 5ce7746 commit 48d4e95

File tree

1 file changed

+10
-5
lines changed

1 file changed

+10
-5
lines changed

specification/rooms/v1.rst

Lines changed: 10 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -80,18 +80,23 @@ may be used by other room versions, and as such servers should be aware of which
8080
version room they are dealing with prior to executing a given algorithm.
8181

8282
.. WARNING::
83-
Although room version 1 is the most popular room version, it is known to have
83+
Although there are many rooms using room version 1, it is known to have
8484
undesirable effects. Servers implementing support for room version 1 should be
8585
aware that restrictions should be generally relaxed and that inconsistencies
86-
may occur until room version 2 (or later) is ready and adopted.
86+
may occur.
8787

8888
State resolution
8989
~~~~~~~~~~~~~~~~
9090

9191
.. WARNING::
92-
This section documents the state resolution algorithm as implemented by
93-
Synapse as of December 2017 (and therefore the de-facto Matrix protocol).
94-
However, this algorithm is known to have some problems.
92+
Room version 1 is known to have bugs that can cause the state of rooms to reset
93+
to older versions of the room's state. For example this could mean that users
94+
who had joined the room may be removed from the room, admins and moderators
95+
could lose their power level, and users who have been banned from the room may
96+
be able to rejoin. Other state events such as the the room's name or topic could
97+
also reset to a previous version.
98+
99+
This is fixed in the state resolution algorithm introduced in room version 2.
95100

96101
The room state :math:`S'(E)` after an event :math:`E` is defined in terms of
97102
the room state :math:`S(E)` before :math:`E`, and depends on whether

0 commit comments

Comments
 (0)