comments to AwsChart/EventChart/HealthChart

Author: Jeffrey Na

app/charts/AwsChart.tsx

@@ -20,7 +20,7 @@ interface SoloStyles {
 
 /** 
  * @params props - the props object containing relevant data.
- * @desc Memoized component to generate an AWS chart with formatted data.
+ * @desc Handles AWS Charts. Memoized component to generate an AWS chart with formatted data.
  * @returns {JSX.Element} The JSX element with the AWS chart.
  */
 const AwsChart: React.FC<any> = React.memo(props => {

app/charts/EventChart.tsx

@@ -29,7 +29,9 @@ type PlotlyData = {
 };
 
 /** 
- * @desc 
+ * @params {EventChartProps} props - the props object containing relevant data.
+ * @desc Handles k8s metrics. Memoized component to generate event chart with formatted data 
+ * @returns {JSX.Element} The JSX element with the event chart.
  */
 const EventChart: React.FC<EventChartProps> = React.memo(props => {
   const { metricName, chartData, sizing, colourGenerator } = props;

app/charts/HealthChart.tsx

@@ -27,7 +27,7 @@ type PlotlyData = {
 
 /**
  * @params {HealthChartProps} props - the props object containing relevant data.
- * @desc Memoized component to generate a health chart with formatted data.
+ * @desc Handles microservices metrics. Memoized component to generate a health chart with formatted data.
  * @returns {JSX.Element} The JSX element with the health chart. 
  */
 const HealthChart: React.FC<HealthChartProps> = React.memo(props => {