From fd298b1229ba697bcda4767388d6e5ddbcf107a0 Mon Sep 17 00:00:00 2001
From: Tristan van Berkom <tristan@codethink.co.uk>
Date: Mon, 23 Nov 2020 15:41:14 +0900
Subject: element.py: Added missing api doc comment for _walk_artifact_files()

---
 src/buildstream/element.py | 8 ++++++++
 1 file changed, 8 insertions(+)

(limited to 'src')

diff --git a/src/buildstream/element.py b/src/buildstream/element.py
index c09bb2d18..efec5e714 100644
--- a/src/buildstream/element.py
+++ b/src/buildstream/element.py
@@ -2417,6 +2417,14 @@ class Element(Plugin):
                         rdep.__buildable_callback(rdep)
                         rdep.__buildable_callback = None
 
+    # _walk_artifact_files()
+    #
+    # A generator which yields all of the files cached in the
+    # element's artifact.
+    #
+    # Yields:
+    #    (str): Filenames in the artifact
+    #
     def _walk_artifact_files(self):
         yield from self.__artifact.get_files().walk()
 
-- 
cgit v1.2.1