refactor: refactor comments around trip overlay hiding

Author: miles-grant-ibigroup

Diff for: lib/components/map/connected-endpoints-overlay.js

@@ -14,6 +14,10 @@ import { getActiveSearch, getShowUserSettings } from '../../util/state'
 const mapStateToProps = (state, ownProps) => {
   const { viewedRoute } = state.otp.ui
   // If trip viewer is not active, do not show trip on map
+  // mainPanelContent is null whenever the trip planner is active.
+  // Some views like the stop viewer can be accessed via the trip planner
+  // or the route viewer, so include a route being viewed as a condition
+  // for hiding
   if (state.otp.ui.mainPanelContent !== null && viewedRoute) {
     return {}
   }

Diff for: lib/components/map/connected-transitive-overlay.js

@@ -10,6 +10,10 @@ const mapStateToProps = (state, ownProps) => {
   const { viewedRoute } = state.otp.ui
 
   // If trip viewer is not active, do not show trip on map
+  // mainPanelContent is null whenever the trip planner is active.
+  // Some views like the stop viewer can be accessed via the trip planner
+  // or the route viewer, so include a route being viewed as a condition
+  // for hiding
   if (state.otp.ui.mainPanelContent !== null && viewedRoute) {
     return {}
   }