tweak comments

elastic · May 22, 2024 · c15ee16 · c15ee16
1 parent 222222f
commit c15ee16
Show file tree

Hide file tree

Showing 2 changed files with 4 additions and 0 deletions.
diff --git a/examples/response_stream/server/routes/reducer_stream.ts b/examples/response_stream/server/routes/reducer_stream.ts
@@ -101,6 +101,8 @@ export const defineReducerStreamRoute = (router: IRouter, logger: Logger) => {
                 // Throw an error. It should not crash Kibana!
                 // It should be caught and logged to the Kibana server console.
                 // The stream will just stop but the client will note receive an error!
+                // In practice this pattern should be avoided as it will just end
+                // the stream without an explanation.
                 throw new Error('There was a (simulated) server side error!');
 
               case 'emit-error':

diff --git a/examples/response_stream/server/routes/redux_stream.ts b/examples/response_stream/server/routes/redux_stream.ts
@@ -101,6 +101,8 @@ export const defineReduxStreamRoute = (router: IRouter, logger: Logger) => {
                 // Throw an error. It should not crash Kibana!
                 // It should be caught and logged to the Kibana server console.
                 // The stream will just stop but the client will note receive an error!
+                // In practice this pattern should be avoided as it will just end
+                // the stream without an explanation.
                 throw new Error('There was a (simulated) server side error!');
 
               case 'emit-error':