From 39b22267d6dcdf30d5b3641ecc582ce94d67e8d5 Mon Sep 17 00:00:00 2001
From: Christoph Kluge <christoph.kluge@fau.de>
Date: Wed, 16 Oct 2024 16:03:31 +0200
Subject: [PATCH] Update component descriptions

---
 web/frontend/src/systems/NodeList.svelte             | 7 ++++---
 web/frontend/src/systems/nodelist/NodeInfo.svelte    | 7 ++++---
 web/frontend/src/systems/nodelist/NodeListRow.svelte | 6 +++---
 3 files changed, 11 insertions(+), 9 deletions(-)

diff --git a/web/frontend/src/systems/NodeList.svelte b/web/frontend/src/systems/NodeList.svelte
index b8eacdf..5d106b6 100644
--- a/web/frontend/src/systems/NodeList.svelte
+++ b/web/frontend/src/systems/NodeList.svelte
@@ -2,9 +2,10 @@
     @component Cluster Per Node List component; renders current state of SELECTABLE metrics for ALL nodes
 
     Properties:
-    - `cluster String`: The cluster to show status information for
-    - `from Date?`: Custom Time Range selection 'from' [Default: null]
-    - `to Date?`: Custom Time Range selection 'to' [Default: null]
+    - `cluster String`: The nodes' cluster
+    - `data [Object]`: The node data array for all nodes
+    - `selectedMetrics [String]`: The array of selected metrics
+    - `selectedMetrics Object`: The object of metric units
  -->
 
 <script>
diff --git a/web/frontend/src/systems/nodelist/NodeInfo.svelte b/web/frontend/src/systems/nodelist/NodeInfo.svelte
index 15effe2..4ff4e1c 100644
--- a/web/frontend/src/systems/nodelist/NodeInfo.svelte
+++ b/web/frontend/src/systems/nodelist/NodeInfo.svelte
@@ -1,9 +1,10 @@
 <!--
-    @component Displays node info, serves link to signle node page
+    @component Displays node info, serves links to single node page and lists
 
     Properties:
-    - `job Object`: The Job Object (GraphQL.Job)
-    - `jobTags [Number]?`: The jobs tags as IDs, default useful for dynamically updating the tags [Default: job.tags]
+    - `cluster String`: The nodes' cluster
+    - `subCluster String`: The nodes' subCluster
+    - `cluster String`: The nodes' hostname
  -->
 
 <script>
diff --git a/web/frontend/src/systems/nodelist/NodeListRow.svelte b/web/frontend/src/systems/nodelist/NodeListRow.svelte
index a510b0e..3aa84b8 100644
--- a/web/frontend/src/systems/nodelist/NodeListRow.svelte
+++ b/web/frontend/src/systems/nodelist/NodeListRow.svelte
@@ -2,9 +2,9 @@
     @component Data row for a single node displaying metric plots
 
     Properties:
-    - `job Object`: The job object (GraphQL.Job)
-    - `metrics [String]`: Currently selected metrics
-    - `plotWidth Number`: Width of the sub-components
+    - `cluster String`: The nodes' cluster
+    - `nodeData Object`: The node data object including metric data
+    - `selectedMetrics [String]`: The array of selected metrics
  -->
 
 <script>