Skip to content

Commit 7084b66

Browse files
committed
Made doc text a bit more clear
1 parent ac12ead commit 7084b66

File tree

1 file changed

+5
-0
lines changed

1 file changed

+5
-0
lines changed

hdl_checker/parser_utils.py

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -152,10 +152,15 @@ def make(cls, iterable): # pylint: disable=arguments-differ
152152
Creates a JsonSourceEntry from all supported formats:
153153
- str
154154
- [str, {"library": "<library_name>", "flags": BuildFlags}]
155+
- {"path": str, <- Mandatory
156+
"library": <library_name>, <- Optional
157+
"flags": <BuildFlags>, <- Optional
158+
}
155159
"""
156160
path = iterable
157161
info = {} # type: Dict[str, Union[None, str, BuildFlags]]
158162

163+
# Support both
159164
if not isinstance(path, six.string_types):
160165
path = iterable[0]
161166
info = iterable[1]

0 commit comments

Comments
 (0)