better deprecated message format

elastic · Jan 11, 2024 · 3a83646 · 3a83646
1 parent 4906694
commit 3a83646
Showing 1 changed file with 9 additions and 3 deletions.
diff --git a/x-pack/plugins/security_solution/public/timelines/store/selectors.ts b/x-pack/plugins/security_solution/public/timelines/store/selectors.ts
@@ -28,20 +28,26 @@ export const getTimelineShowStatusByIdSelector = () =>
     changed: timeline?.changed ?? false,
   }));
 
-// deprecated
+/**
+ * @deprecated
+ */
 const timelineByIdState = (state: State): TimelineById => state.timeline.timelineById;
 
 const selectCallOutUnauthorizedMsg = (state: State): boolean =>
   state.timeline.showCallOutUnauthorizedMsg;
 
-// deprecated, prefer using selectTimelineById below
+/**
+ * @deprecated prefer using selectTimelineById below
+ */
 export const selectTimeline = (state: State, timelineId: string): TimelineModel =>
   state.timeline.timelineById[timelineId];
 
 export const selectInsertTimeline = (state: State): InsertTimeline | null =>
   state.timeline.insertTimeline;
 
-// deprecated, prefer using selectTimelineById below
+/**
+ * @deprecated prefer using selectTimelineById below
+ */
 export const timelineByIdSelector = createSelector(
   timelineByIdState,
   (timelineById) => timelineById