From 8c7d7862fb69cec89e74d170f2357c57c8de2f97 Mon Sep 17 00:00:00 2001
From: Jason Wesson <jwesson@2u.com>
Date: Fri, 8 Sep 2023 02:48:00 +0000
Subject: [PATCH] add: comments to add clarity on how PLuginSlot knows what
 plugin URLs to use

---
 example/src/PluginsPage.jsx | 2 +-
 src/plugins/PluginSlot.jsx  | 3 +++
 2 files changed, 4 insertions(+), 1 deletion(-)

diff --git a/example/src/PluginsPage.jsx b/example/src/PluginsPage.jsx
index 9b8928a8c..da1bcca7f 100644
--- a/example/src/PluginsPage.jsx
+++ b/example/src/PluginsPage.jsx
@@ -20,7 +20,7 @@ export default function PluginsPage() {
       </p>
       <div className="d-flex flex-column">
         <PluginSlot
-          id="example"
+          id="example" // this is how PluginSlot knows which set of plugin URLs to grab from JS config
           className="d-flex flex-column"
           pluginProps={{
             className: 'flex-grow-1',
diff --git a/src/plugins/PluginSlot.jsx b/src/plugins/PluginSlot.jsx
index 3fe6a67e6..813c0ebc8 100644
--- a/src/plugins/PluginSlot.jsx
+++ b/src/plugins/PluginSlot.jsx
@@ -11,6 +11,9 @@ import PluginContainer from './PluginContainer';
 const PluginSlot = forwardRef(({
   as, id, intl, pluginProps, children, ...props
 }, ref) => {
+  /* the plugins below are obtained by the id passed into PluginSlot by the Host MFE. See example/src/PluginsPage.jsx
+  for an example of how PluginSlot is populated, and example/src/index.jsx for a dummy JS config that holds all plugins
+  */
   const { plugins, keepDefault } = usePluginSlot(id);
 
   const { fallback } = pluginProps;