adds jsdocs

akhenry · Oct 8, 2024 · 7bdccdd · 7bdccdd
1 parent e56dc64
commit 7bdccdd
Showing 1 changed file with 6 additions and 0 deletions.
diff --git a/tests/e2e/yamcs/telemetryTables.e2e.spec.mjs b/tests/e2e/yamcs/telemetryTables.e2e.spec.mjs
@@ -110,6 +110,12 @@ test.describe("Telemetry Tables tests @yamcs", () => {
         expect(await assertTableRowsInOrder(telemTableAsc, 'asc')).toBe(true);
     });
 
+    /**
+     * Returns whether a list of timestamp based rows are in asc or desc order
+     * @param { Node } telemTable Node for telemetry table
+     * @param { string } order 'asc' or 'desc'
+     * @returns {Boolean} All table rows are in order
+     */
     async function assertTableRowsInOrder(telemTable, order) {
         let rowsAreInOrder = false;
         const allRows = await (await telemTable.getByLabel('Table Row')).all();