Comments

2 files changed, 6 insertions, 1 deletions

diff --git a/synapse/storage/event_push_actions.py b/synapse/storage/event_push_actions.py

index 28226455bf..ea56d4d065 100644
--- a/synapse/storage/event_push_actions.py
+++ b/synapse/storage/event_push_actions.py
@@ -762,7 +762,8 @@ class EventPushActionsStore(SQLBaseStore):
         Args:
             event_id (str)
             user_id (str)
-            actions (list)
+            actions (list[dict|str]): An action can either be a string or
+                dict.
 
         Returns:
             Deferred
diff --git a/synapse/storage/schema/delta/47/push_actions_staging.sql b/synapse/storage/schema/delta/47/push_actions_staging.sql

index ec4b1d7d42..edccf4a96f 100644
--- a/synapse/storage/schema/delta/47/push_actions_staging.sql
+++ b/synapse/storage/schema/delta/47/push_actions_staging.sql
@@ -13,6 +13,10 @@
  * limitations under the License.
  */
 
+-- Temporary staging area for push actions that have been calculated for an
+-- event, but the event hasn't yet been persisted.
+-- When the event is persisted the rows are moved over to the
+-- event_push_actions table.
 CREATE TABLE event_push_actions_staging (
     event_id TEXT NOT NULL,
     user_id TEXT NOT NULL,