From 757132397a3cbf0241773791bc3e993e27259f01 Mon Sep 17 00:00:00 2001 From: Andrew Morgan Date: Tue, 4 Oct 2022 10:11:42 +0100 Subject: [PATCH 1/4] Remove reference to a 'room_id' key for typing events Typing events do not contain a 'room_id' key. They are instead scoped to a room, i.e. under a specific room's ephemeral events listing in a /sync response. Remove references to 'room_id' to reduce confusion. --- content/client-server-api/modules/typing_notifications.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/content/client-server-api/modules/typing_notifications.md b/content/client-server-api/modules/typing_notifications.md index 722c011f1..52886867c 100644 --- a/content/client-server-api/modules/typing_notifications.md +++ b/content/client-server-api/modules/typing_notifications.md @@ -6,8 +6,8 @@ type: module Users may wish to be informed when another user is typing in a room. This can be achieved using typing notifications. These are ephemeral -events scoped to a `room_id`. This means they do not form part of the -[Event Graph](index.html#event-graphs) but still have a `room_id` key. +events scoped to a room, but they do not form part of the +[Event Graph](index.html#event-graphs). #### Events From 125fe7c36965c962b48c60d4282c4539e168a3b6 Mon Sep 17 00:00:00 2001 From: Andrew Morgan Date: Tue, 4 Oct 2022 10:17:45 +0100 Subject: [PATCH 2/4] changelog --- changelogs/client_server/newsfragments/1265.clarification | 1 + 1 file changed, 1 insertion(+) create mode 100644 changelogs/client_server/newsfragments/1265.clarification diff --git a/changelogs/client_server/newsfragments/1265.clarification b/changelogs/client_server/newsfragments/1265.clarification new file mode 100644 index 000000000..ca5f3aea5 --- /dev/null +++ b/changelogs/client_server/newsfragments/1265.clarification @@ -0,0 +1 @@ +Fix various typos throughout the specification. \ No newline at end of file From 62009e30626241d601b48ad9fc867f92979fe056 Mon Sep 17 00:00:00 2001 From: Andrew Morgan Date: Wed, 5 Oct 2022 10:51:42 +0100 Subject: [PATCH 3/4] reword room-scoped ephemeral events blurb --- content/client-server-api/modules/typing_notifications.md | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/content/client-server-api/modules/typing_notifications.md b/content/client-server-api/modules/typing_notifications.md index 52886867c..5002d60cd 100644 --- a/content/client-server-api/modules/typing_notifications.md +++ b/content/client-server-api/modules/typing_notifications.md @@ -6,8 +6,9 @@ type: module Users may wish to be informed when another user is typing in a room. This can be achieved using typing notifications. These are ephemeral -events scoped to a room, but they do not form part of the -[Event Graph](index.html#event-graphs). +events, so they do not form part of the +[Event Graph](index.html#event-graphs), even though they are scoped +to a room. #### Events From 3dccc77d670fc8a7329c83cec9bac7ff50ec920e Mon Sep 17 00:00:00 2001 From: Andrew Morgan Date: Wed, 5 Oct 2022 10:53:23 +0100 Subject: [PATCH 4/4] reword p2 --- content/client-server-api/modules/typing_notifications.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/content/client-server-api/modules/typing_notifications.md b/content/client-server-api/modules/typing_notifications.md index 5002d60cd..b3ce23723 100644 --- a/content/client-server-api/modules/typing_notifications.md +++ b/content/client-server-api/modules/typing_notifications.md @@ -7,7 +7,7 @@ type: module Users may wish to be informed when another user is typing in a room. This can be achieved using typing notifications. These are ephemeral events, so they do not form part of the -[Event Graph](index.html#event-graphs), even though they are scoped +[Event Graph](index.html#event-graphs). Typing notifications are scoped to a room. #### Events