[buildstream] 09/30: buildstream/_project.py: Document Project._load_pass.

[tv...@apache.org]

This is an automated email from the ASF dual-hosted git repository.

tvb pushed a commit to branch valentindavid/flatpak-demo
in repository https://gitbox.apache.org/repos/asf/buildstream.git

commit d97b2c1ee7ef4eab2fb1f11079fb22e779693f08
Author: Valentin David <va...@codethink.co.uk>
AuthorDate: Wed Jun 27 17:03:57 2018 +0200

    buildstream/_project.py: Document Project._load_pass.
---
 buildstream/_project.py | 10 ++++++++++
 1 file changed, 10 insertions(+)

diff --git a/buildstream/_project.py b/buildstream/_project.py
index b4aa1ef..67eba0f 100644
--- a/buildstream/_project.py
+++ b/buildstream/_project.py
@@ -479,6 +479,16 @@ class Project():
 
             self._shell_host_files.append(mount)
 
+    # _load_pass():
+    #
+    # Loads parts of the project configuration that are different
+    # for first and second pass configurations.
+    #
+    # Args:
+    #    config (dict) - YaML node of the configuration file.
+    #    output (ProjectConfig) - ProjectConfig to load configuration onto.
+    #    ignore_unknown (bool) - Whether option loader shoud ignore unknown options.
+    #
     def _load_pass(self, config, output, ignore_unknown):
 
         # Element and Source  type configurations will be composited later onto