Clarify before redaction event timing

matrix-org · May 13, 2019 · f411d50 · f411d50
1 parent 00851df
commit f411d50
Showing 1 changed file with 6 additions and 2 deletions.
diff --git a/src/models/relations.js b/src/models/relations.js
@@ -124,8 +124,12 @@ export default class Relations extends EventEmitter {
  }
 
  /**
- * For relations that are about to be redacted, remove them from aggregation
- * data sets and emit an update event.
+ * For relations that have been redacted, we want to remove them from
+ * aggregation data sets and emit an update event.
+ *
+ * To do so, we listen for `Room.beforeRedaction`, which happens:
+ * - after the server accepted the redaction and remote echoed back to us
+ * - before the original event has been marked redacted in the client
  *
  * @param {MatrixEvent} redactedEvent
  * The original relation event that is about to be redacted.