summary refs log tree commit diff
path: root/synapse
diff options
context:
space:
mode:
authorErik Johnston <erik@matrix.org>2018-10-12 13:49:48 +0100
committerErik Johnston <erik@matrix.org>2018-10-12 13:49:48 +0100
commit67a1e315cc7f8b270ec87e0ab6e58aa2adaee32d (patch)
tree17d2ffad560eb86b55c73ee442d728e2e1697ee3 /synapse
parentNewsfile (diff)
downloadsynapse-67a1e315cc7f8b270ec87e0ab6e58aa2adaee32d.tar.xz
Fix up comments
Diffstat (limited to 'synapse')
-rw-r--r--synapse/storage/state.py6
1 files changed, 3 insertions, 3 deletions
diff --git a/synapse/storage/state.py b/synapse/storage/state.py
index 3f08f447a3..f7cf5c86c9 100644
--- a/synapse/storage/state.py
+++ b/synapse/storage/state.py
@@ -1044,9 +1044,9 @@ class StateGroupWorkerStore(EventsWorkerStore, SQLBaseStore):
     def _is_state_group_referenced(self, txn, state_group):
         """Checks if a given state group is referenced, or is safe to delete.
 
-        A state groups is referenced if it or any of its descendants are
-        pointed at by an event. (A descendant is a group which has the given
-        state_group as a prev group)
+        A state group is referenced if it or any of its descendants are
+        pointed at by an event. (A descendant is a state_group whose chain of
+        prev_groups includes the given state_group.)
         """
 
         # We check this by doing a depth first search to look for any