From 02b33766ee37bae817130c5de1d98ab5d363dc1e Mon Sep 17 00:00:00 2001
From: David Baker <dave@matrix.org>
Date: Fri, 8 Jan 2016 20:26:07 +0000
Subject: [PATCH] Document the order of the room timeline because I can never
 remember which way round it is.

---
 lib/models/room.js | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/lib/models/room.js b/lib/models/room.js
index 7fe3ea5c8..46c07fb90 100644
--- a/lib/models/room.js
+++ b/lib/models/room.js
@@ -59,7 +59,7 @@ function synthesizeReceipt(userId, event, receiptType) {
  * @prop {string} roomId The ID of this room.
  * @prop {string} name The human-readable display name for this room.
  * @prop {Array<MatrixEvent>} timeline The ordered list of message events for
- * this room.
+ * this room, with the oldest event at index 0.
  * @prop {object} tags Dict of room tags; the keys are the tag name and the values
  * are any metadata associated with the tag - e.g. { "fav" : { order: 1 } }
  * @prop {RoomState} oldState The state of the room at the time of the oldest