Skip to content

Commit

Permalink
doc: add docstring for get_wires
Browse files Browse the repository at this point in the history
  • Loading branch information
yihuajack committed Sep 7, 2022
1 parent f8ed06c commit a5bbe53
Showing 1 changed file with 2 additions and 1 deletion.
3 changes: 2 additions & 1 deletion sootty/storage/wiregroup.py
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,7 @@ def find(self, name: str):
raise SoottyError(f"Wire '{name}' does not exist.")

def get_names(self):
"""Returns list of all wire names."""
"""Returns a dictionary of all wire names of this wiregroup or a list if this wiregroup is the innermost one."""
if self.groups:
names = dict()
if self.wires:
Expand All @@ -53,6 +53,7 @@ def get_names(self):
return names

def get_wires(self):
"""Returns a dictionary of all wires of this wiregroup or a list if this wiregroup is the innermost one."""
if self.groups:
wires = dict()
if self.wires:
Expand Down

0 comments on commit a5bbe53

Please sign in to comment.