diff mbox series

[03/15] binman: Tidy up comments for Entry.GetEntryArgsOrProps()

Message ID 20240826191143.426387-4-sjg@chromium.org
State New
Delegated to: Simon Glass
Headers show
Series binman: More patches to support VBE | expand

Commit Message

Simon Glass Aug. 26, 2024, 7:11 p.m. UTC 
Improve the comments for this function.

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

 tools/binman/entry.py | 10 +++++++++-
 1 file changed, 9 insertions(+), 1 deletion(-)
diff mbox series

Patch

diff --git a/tools/binman/entry.py b/tools/binman/entry.py
index 6d2f3789940..7d4d4692776 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