From d6dd22cf984029c77a1643a623b5c34bd60d5dc2 Mon Sep 17 00:00:00 2001
From: Albin Vass <albin.vass@volvocars.com>
Date: Tue, 26 Jan 2021 11:23:41 +0100
Subject: [PATCH] Add a note how to access zuul.items variable

Change-Id: I81ee4bfa5e95187aca0cdb2d0f54d133bad02dd1
---
 doc/source/reference/jobs.rst | 6 ++++++
 1 file changed, 6 insertions(+)

diff --git a/doc/source/reference/jobs.rst b/doc/source/reference/jobs.rst
index ea9940bc79..28d2bd2e7d 100644
--- a/doc/source/reference/jobs.rst
+++ b/doc/source/reference/jobs.rst
@@ -439,6 +439,12 @@ of item.
    .. var:: items
       :type: list
 
+      .. note::
+
+         ``zuul.items`` conflicts with the ``items()`` builtin so the
+         variable can only be accessed with python dictionary like syntax,
+         e.g: ``zuul['items']``
+
       A list of dictionaries, each representing an item being tested
       with this change with the format: