From 6b8bf41880c42cd503a53ac241516fb16953ecca Mon Sep 17 00:00:00 2001 From: Kris West Date: Mon, 21 Feb 2022 21:31:08 +0000 Subject: [PATCH] Apply suggestions from code review Co-authored-by: Hugh Troeger --- docs/api/ref/Errors.md | 2 +- docs/api/spec.md | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/api/ref/Errors.md b/docs/api/ref/Errors.md index 5ebbbdc74..53dd365c3 100644 --- a/docs/api/ref/Errors.md +++ b/docs/api/ref/Errors.md @@ -54,7 +54,7 @@ enum ChannelError { Contains constants representing the errors that can be encountered when calling channels using the [`joinUserChannel`](DesktopAgent#joinuserchannel) or [`getOrCreateChannel`](DesktopAgent#getorcreatechannel) methods, or the [`getCurrentContext`](Channel#getcurrentcontext), [`broadcast`](Channel#broadcast) or [`addContextListener`](Channel#addcontextlistener) methods on the `Channel` object. #### See also -* [`DesktopAgent.joinUserChannel`](DesktopAgent#joinusercannel) +* [`DesktopAgent.joinUserChannel`](DesktopAgent#joinuserchannel) * [`DesktopAgent.getOrCreateChannel`](DesktopAgent#getorcreatechannel) * [`Channel.broadcast`](Channel#broadcast) * [`Channel.addContextListener`](Channel#addcontextlistener) diff --git a/docs/api/spec.md b/docs/api/spec.md index e3e0e6098..b85a476e3 100644 --- a/docs/api/spec.md +++ b/docs/api/spec.md @@ -299,7 +299,7 @@ fdc3.joinUserChannel(redChannel.id); Calling `fdc3.broadcast` will now route context to the joined channel. -Channel implementations should ensure that context messages broadcast by an application on a channel should not be delivered back to that same application if they are joined to the channel. +Channel implementations SHOULD ensure that context messages broadcast by an application on a channel are not delivered back to that same application if they are joined to the channel. > Prior to FDC3 2.0, 'user' channels were known as 'system' channels. They were renamed in FDC 2.0 to reflect their intended usage, rather than the fact that they are created by system (which could also create 'app' channels). The `joinChannel` function was also renamed to `joinUserChannel` to clarify that it is only intended to be used to join 'user', rather than 'app', channels.