From: Simon Glass <sjg@chromium.org>
Date: Mon, 26 Aug 2024 19:11:31 +0000 (-0600)
Subject: binman: Tidy up comments for Entry.GetEntryArgsOrProps()
X-Git-Url: http://git.dujemihanovic.xyz/%22/img/sics.gif/%22/static/git-favicon.png?a=commitdiff_plain;h=be45bb941abe18aea0ae03af3d4ce8797885916f;p=u-boot.git

binman: Tidy up comments for Entry.GetEntryArgsOrProps()

Improve the comments for this function.

Signed-off-by: Simon Glass <sjg@chromium.org>
---

diff --git a/tools/binman/entry.py b/tools/binman/entry.py
index 6d2f378994..7d4d469277 100644
--- a/tools/binman/entry.py
+++ b/tools/binman/entry.py
@@ -576,8 +576,16 @@ class Entry(object):
     def GetEntryArgsOrProps(self, props, required=False):
         """Return the values of a set of properties
 
+        Looks up the named entryargs and returns the value for each. If any
+        required ones are missing, the error is reported to the user.
+
         Args:
-            props: List of EntryArg objects
+            props (list of EntryArg): List of entry arguments to look up
+            required (bool): True if these entry arguments are required
+
+        Returns:
+            list of values: one for each item in props, the type is determined
+                by the EntryArg's 'datatype' property (str or int)
 
         Raises:
             ValueError if a property is not found