From d0fd6e985fac4228dc33d5165cc0094dd33ec903 Mon Sep 17 00:00:00 2001
From: David Baker <dave@matrix.org>
Date: Fri, 16 Sep 2016 17:48:08 +0100
Subject: [PATCH] Document paranoia on the startAtBottom param

---
 src/components/structures/ScrollPanel.js | 4 ++++
 1 file changed, 4 insertions(+)

diff --git a/src/components/structures/ScrollPanel.js b/src/components/structures/ScrollPanel.js
index 1c3bedfabb..6970cd190c 100644
--- a/src/components/structures/ScrollPanel.js
+++ b/src/components/structures/ScrollPanel.js
@@ -79,6 +79,10 @@ module.exports = React.createClass({
 
         /* startAtBottom: if set to true, the view is assumed to start
          * scrolled to the bottom.
+         * XXX: It's likley this is unecessary and can be derived from
+         * stickyBottom, but I'm adding an extra parameter to ensure
+         * behaviour stays the same for other uses of ScrollPanel.
+         * If so, let's remove this parameter down the line.
          */
         startAtBottom: React.PropTypes.bool,