From 5a6ce5cd285f3da120f713dc45dace5681e980e7 Mon Sep 17 00:00:00 2001
From: Nicholas McDonnell <50747025+mcdonnnj@users.noreply.github.com>
Date: Thu, 5 Dec 2024 06:05:27 -0500
Subject: [PATCH] Fix the job summary table example
This updates the example of adding a table to a job summary using
core.summary.addTable() to be correct. It also changes the data row to
use strings instead of objects to show both ways that cell data can be
defined. This mirrors the job summary announcement blog post.
---
packages/core/README.md | 16 ++++++++--------
1 file changed, 8 insertions(+), 8 deletions(-)
diff --git a/packages/core/README.md b/packages/core/README.md
index ac8ced92..4d96f9d2 100644
--- a/packages/core/README.md
+++ b/packages/core/README.md
@@ -451,17 +451,17 @@ For example
```typescript
const tableData = [
- {data: 'Header1', header: true},
- {data: 'Header2', header: true},
- {data: 'Header3', header: true},
- {data: 'MyData1'},
- {data: 'MyData2'},
- {data: 'MyData3'}
+ [
+ {data: 'Header1', header: true},
+ {data: 'Header2', header: true},
+ {data: 'Header3', header: true}
+ ],
+ ['MyData1', 'MyData2', 'MyData3']
]
// Add an HTML table
-core.summary.addTable([tableData])
-// Output:
Header1 | Header2 | Header3 |
---|
|
MyData1 | MyData2 | MyData3 |
+core.summary.addTable(tableData)
+// Output: Header1 | Header2 | Header3 |
---|
MyData1 | MyData2 | MyData3 |
```