[ML] Improve comments.

elastic · May 17, 2022 · a6abf0e · a6abf0e
1 parent d9dcba3
commit a6abf0e
Show file tree

Hide file tree

Showing 2 changed files with 2 additions and 0 deletions.
diff --git a/x-pack/plugins/aiops/public/components/explain_log_rate_spikes/explain_log_rate_spikes.tsx b/x-pack/plugins/aiops/public/components/explain_log_rate_spikes/explain_log_rate_spikes.tsx
@@ -19,6 +19,7 @@ import { initialState, streamReducer } from './stream_reducer';
  * ExplainLogRateSpikes props require a data view.
  */
 export interface ExplainLogRateSpikesProps {
+  /** The data view to analyze. */
   dataView: DataView;
 }
 

diff --git a/x-pack/plugins/aiops/public/shared_lazy_components.tsx b/x-pack/plugins/aiops/public/shared_lazy_components.tsx
@@ -24,6 +24,7 @@ const LazyWrapper: FC = ({ children }) => (
 
 /**
  * Lazy-wrapped ExplainLogRateSpikes React component
+ * @param {ExplainLogRateSpikesProps}  props - properties specifying the data on which to run the analysis.
  */
 export const ExplainLogRateSpikes: FC<ExplainLogRateSpikesProps> = (props) => (
   <LazyWrapper>