]> git.dujemihanovic.xyz Git - u-boot.git/commitdiff
binman: Tidy up comments for Entry.GetEntryArgsOrProps()
authorSimon Glass <sjg@chromium.org>
Mon, 26 Aug 2024 19:11:31 +0000 (13:11 -0600)
committerSimon Glass <sjg@chromium.org>
Thu, 26 Sep 2024 10:40:30 +0000 (12:40 +0200)
Improve the comments for this function.

Signed-off-by: Simon Glass <sjg@chromium.org>
tools/binman/entry.py

index 6d2f378994064c077fd229addf5c704c2ce8f2c7..7d4d4692776eee6f5065edf25f0f70513a2e264d 100644 (file)
@@ -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