Skip to content

Commit f6e9bbb

Browse files
committed
Document Node class init params
1 parent 54963fb commit f6e9bbb

File tree

1 file changed

+13
-30
lines changed

1 file changed

+13
-30
lines changed

python/pyrogue/_Node.py

Lines changed: 13 additions & 30 deletions
Original file line numberDiff line numberDiff line change
@@ -139,19 +139,18 @@ class Node(object):
139139
140140
Parameters
141141
----------
142-
name :
143-
global name of object
144-
145-
description :
146-
Description of object
147-
148-
path :
149-
full path to the node (ie. node1.node2.node3)
150-
151-
expand :
152-
153-
guiGroup :
154-
arbitrary groups for gui and graphical aesthetic purposes
142+
name : str
143+
Global name of the node.
144+
description : str, optional (default = "")
145+
Human-readable description.
146+
expand : bool, optional (default = True)
147+
Default GUI expand state.
148+
hidden : bool, optional (default = False)
149+
If True, add the node to the ``Hidden`` group.
150+
groups : list[str], optional
151+
Groups to assign.
152+
guiGroup : str, optional
153+
GUI grouping label.
155154
"""
156155
_nodeCount = 0
157156

@@ -165,23 +164,7 @@ def __init__(
165164
groups: Optional[list[str]] = None,
166165
guiGroup: Optional[str] = None,
167166
) -> None:
168-
"""Initialize the node.
169-
170-
Parameters
171-
----------
172-
name : str
173-
Global name of the node.
174-
description : str, optional (default = "")
175-
Human-readable description.
176-
expand : bool, optional (default = True)
177-
Default GUI expand state.
178-
hidden : bool, optional (default = False)
179-
If True, add the node to the ``Hidden`` group.
180-
groups : list[str], optional
181-
Groups to assign.
182-
guiGroup : str, optional
183-
GUI grouping label.
184-
"""
167+
"""Initialize the node."""
185168
pr.Node._nodeCount += 1
186169

187170
# Public attributes

0 commit comments

Comments
 (0)