Comment on the order of the arrays

This commit is contained in:
Mark Haines 2017-06-02 11:14:04 +01:00
parent 4f95f6a18b
commit a201f5e643

View file

@ -41,6 +41,7 @@ type QueryLatestEventsAndStateResponse struct {
// The latest events in the room. // The latest events in the room.
LatestEvents []gomatrixserverlib.EventReference LatestEvents []gomatrixserverlib.EventReference
// The state events requested. // The state events requested.
// This list will be in an arbitrary order.
StateEvents []gomatrixserverlib.Event StateEvents []gomatrixserverlib.Event
} }
@ -65,6 +66,7 @@ type QueryStateAfterEventsResponse struct {
// If some of previous events do not exist this will be false and StateEvents will be empty. // If some of previous events do not exist this will be false and StateEvents will be empty.
PrevEventsExist bool PrevEventsExist bool
// The state events requested. // The state events requested.
// This list will be in an arbitrary order.
StateEvents []gomatrixserverlib.Event StateEvents []gomatrixserverlib.Event
} }
@ -84,6 +86,7 @@ type QueryEventsByIDResponse struct {
// If the roomserver thinks it has a copy of the event, but // If the roomserver thinks it has a copy of the event, but
// fails to read it from the database then it will fail // fails to read it from the database then it will fail
// the entire request. // the entire request.
// This list will be in an arbitrary order.
Events []gomatrixserverlib.Event Events []gomatrixserverlib.Event
} }