From a34a61edff5af5c66c619535cec19d4b61ab7e24 Mon Sep 17 00:00:00 2001
From: Oliver <oliver.henry.walters@gmail.com>
Date: Mon, 19 Jul 2021 16:53:15 +1000
Subject: [PATCH] Add doc for new "installed_items" context

---
 docs/report/test.md | 18 ++++++++++++++++++
 1 file changed, 18 insertions(+)

diff --git a/docs/report/test.md b/docs/report/test.md
index a3e3370..6232925 100644
--- a/docs/report/test.md
+++ b/docs/report/test.md
@@ -35,6 +35,7 @@ In addition to the default report context variables, the following context varia
 | part | The Part of which the stock_item is an instance |
 | results | A dict of test result objects, where the 'key' for each test result is a shortened version of the test name (see below) |
 | result_list | A list of each test result object |
+| installed_items | A flattened list representing all `StockItem` objects which are *installed inside* the referenced `StockItem` object |
 
 #### Results
 
@@ -53,3 +54,20 @@ Firmware Checksum: {% raw %}{{ results.firmwarechecksum.value }}.
 Uploaded by {{ results.firmwarechecksum.user }}{% endraw %}
 </p>
 ```
+
+#### Installed Items
+
+The *installed_items* context variable is a list of all `StockItem` instances which are installed inside the `StockItem` referenced by the report template. Each `StockItem` can be dereferenced as follows:
+
+```html
+{% raw %}
+<table>
+    {% for sub_item in installed_items %}
+    <tr>
+        <td>{{ sub_item.full_name }}</td>
+        <td>Serial Number: {{ sub_item.serial }}</td>
+        <td>Pass: {{ sub_item.passedAllRequiredTests }}</td>
+    {% endfor %}
+</table>
+{% endraw %}
+```
\ No newline at end of file