From 02a2b393b80be595469a2ea7aa1d24c4a7933dca Mon Sep 17 00:00:00 2001
From: Sean Perkins <sean@ionic.io>
Date: Mon, 3 Jul 2023 12:39:21 -0400
Subject: [PATCH] chore: comment why <Routes /> is necessary

---
 .../react-router/src/ReactRouter/ReactRouterViewStack.tsx     | 4 ++++
 1 file changed, 4 insertions(+)

diff --git a/packages/react-router/src/ReactRouter/ReactRouterViewStack.tsx b/packages/react-router/src/ReactRouter/ReactRouterViewStack.tsx
index 593691bfb2..61ba840cc0 100644
--- a/packages/react-router/src/ReactRouter/ReactRouterViewStack.tsx
+++ b/packages/react-router/src/ReactRouter/ReactRouterViewStack.tsx
@@ -73,6 +73,10 @@ export class ReactRouterViewStack extends ViewStacks {
           mount={viewItem.mount}
           removeView={() => this.remove(viewItem)}
         >
+          {/*
+            TODO @sean it is currently required to render a <Routes /> or you will get:
+            Uncaught Error: A <Route> is only ever to be used as the child of <Routes> element, never rendered directly. Please wrap your <Route> in a <Routes>.
+          */}
           <Routes>{React.cloneElement(viewItem.reactElement)}</Routes>
         </ViewLifeCycleManager>
       );