From 80e0700d4862203af573eadc62d73b8e4ef43971 Mon Sep 17 00:00:00 2001 From: Patrick Cloke Date: Tue, 16 May 2023 10:49:06 -0400 Subject: [PATCH] Fix typo. Co-authored-by: Richard van der Hoff <1389908+richvdh@users.noreply.github.com> --- content/client-server-api/modules/event_replacements.md | 2 +- content/client-server-api/modules/mentions.md | 4 +++- 2 files changed, 4 insertions(+), 2 deletions(-) diff --git a/content/client-server-api/modules/event_replacements.md b/content/client-server-api/modules/event_replacements.md index 25f21af2..b6a058df 100644 --- a/content/client-server-api/modules/event_replacements.md +++ b/content/client-server-api/modules/event_replacements.md @@ -296,7 +296,7 @@ they simply serve no purpose within the visible timeline. #### Edits of events with mentions When editing an event with [user and room mentions](#user-and-room-mentions) the -replacement event will hae two `m.mentions` properties: +replacement event will have two `m.mentions` properties: * One at the top-level of the `content`, which should contain mentions due to this edit revision. diff --git a/content/client-server-api/modules/mentions.md b/content/client-server-api/modules/mentions.md index 99741329..6f65f762 100644 --- a/content/client-server-api/modules/mentions.md +++ b/content/client-server-api/modules/mentions.md @@ -1,7 +1,9 @@ ### User and room mentions -This module allows users to mention other users and rooms within a room message. +This module allows users to "mention" other users and rooms within a room event. +This is primarily used as an indicator that the recipient should receive a notification +about the event. This is achieved by including metadata in the `m.mentions` content property of the event. The `m.mentions` property consists of an object with two fields: