summaryrefslogtreecommitdiff
path: root/src
diff options
context:
space:
mode:
authorTristan van Berkom <tristan@codethink.co.uk>2020-11-23 15:41:14 +0900
committerTristan van Berkom <tristan@codethink.co.uk>2020-12-07 17:53:03 +0900
commitfd298b1229ba697bcda4767388d6e5ddbcf107a0 (patch)
tree6db61be35780c2b6f7aa38ad53122fca4fc17025 /src
parent837acb9c3ce9ae17d12f22ee3b2e42dd7223bccf (diff)
downloadbuildstream-fd298b1229ba697bcda4767388d6e5ddbcf107a0.tar.gz
element.py: Added missing api doc comment for _walk_artifact_files()
Diffstat (limited to 'src')
-rw-r--r--src/buildstream/element.py8
1 files changed, 8 insertions, 0 deletions
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()