From 8a03e41a7c2e5cc7ea1434c9e0011f433593ff20 Mon Sep 17 00:00:00 2001 From: Rafael Cascalho Date: Thu, 17 Oct 2019 10:51:34 -0300 Subject: [PATCH] chore: corrected the docs the getRelationsForEvent function --- src/models/event-timeline-set.js | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/src/models/event-timeline-set.js b/src/models/event-timeline-set.js index 693610471..14fa1ca8e 100644 --- a/src/models/event-timeline-set.js +++ b/src/models/event-timeline-set.js @@ -695,10 +695,11 @@ EventTimelineSet.prototype.compareEventOrdering = function(eventId1, eventId2) { * The type of relation involved, such as "m.annotation", "m.reference", "m.replace", etc. * @param {String} eventType * The relation event's type, such as "m.reaction", etc. + * @throws If eventId, relationType or eventType are not valid. * * @returns {?Relations} - * A container for relation events, or undefined if either an event argument is invalid or - * aggregation is disabled. + * A container for relation events or undefined if there are no relation events for + * the relationType. */ EventTimelineSet.prototype.getRelationsForEvent = function( eventId, relationType, eventType,