From dfde67a6fe22535558552060820abfca047540f3 Mon Sep 17 00:00:00 2001
From: Mark Haines <mark.haines@matrix.org>
Date: Fri, 8 Jul 2016 15:57:06 +0100
Subject: Add a comment explaining allow_none

---
 synapse/storage/registration.py | 2 ++
 1 file changed, 2 insertions(+)

(limited to 'synapse')

diff --git a/synapse/storage/registration.py b/synapse/storage/registration.py
index 3a675e53f6..d957a629dc 100644
--- a/synapse/storage/registration.py
+++ b/synapse/storage/registration.py
@@ -128,6 +128,8 @@ class RegistrationStore(SQLBaseStore):
         try:
             if was_guest:
                 # Ensure that the guest user actually exists
+                # ``allow_none=False`` makes this raise an exception
+                # if the row isn't in the database.
                 self._simple_select_one_txn(
                     txn,
                     "users",
-- 
cgit 1.4.1