Skip to content

Commit fc27f2a

Browse files
committed
doc string updates.
1 parent 4e6e84a commit fc27f2a

File tree

3 files changed

+10
-3
lines changed

3 files changed

+10
-3
lines changed

NodeGraphQt/base/node.py

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -310,8 +310,10 @@ def create_property(self, name, value, items=None, range=None,
310310
Args:
311311
name (str): name of the property.
312312
value (object): data.
313-
items (list[str]): items used by widget type attr:`NodePropWidgetEnum.QCOMBO_BOX`
314-
range (tuple or list): ``(min, max)`` values used by :attr:`NodePropWidgetEnum.SLIDER`
313+
items (list[str]): items used by widget type
314+
attr:`NodeGraphQt.constants.NodePropWidgetEnum.QCOMBO_BOX`
315+
range (tuple or list): ``(min, max)`` values used by
316+
:attr:`NodeGraphQt.constants.NodePropWidgetEnum.SLIDER`
315317
widget_type (int): widget flag to display in the
316318
:class:`NodeGraphQt.PropertiesBinWidget`
317319
tab (str): name of the widget tab to display in the

NodeGraphQt/custom_widgets/properties_bin/node_property_widgets.py

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -342,6 +342,11 @@ class PropertiesBinWidget(QtWidgets.QWidget):
342342
properties_bin = PropertiesBinWidget(parent=None, node_graph=graph)
343343
properties_bin.show()
344344
345+
See Also:
346+
:meth:`NodeGraphQt.BaseNode.add_custom_widget`,
347+
:meth:`NodeGraphQt.NodeObject.create_property`,
348+
:attr:`NodeGraphQt.constants.NodePropWidgetEnum`
349+
345350
Args:
346351
parent (QtWidgets.QWidget): parent of the new widget.
347352
node_graph (NodeGraphQt.NodeGraph): node graph.

NodeGraphQt/nodes/base_node.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -152,7 +152,7 @@ def add_custom_widget(self, widget, widget_type=None, tab=None):
152152
widget (NodeBaseWidget): node widget class object.
153153
widget_type: widget flag to display in the
154154
:class:`NodeGraphQt.PropertiesBinWidget`
155-
(default: :attr:`NodePropWidgetEnum.HIDDEN`).
155+
(default: :attr:`NodeGraphQt.constants.NodePropWidgetEnum.HIDDEN`).
156156
tab (str): name of the widget tab to display in.
157157
"""
158158
if not isinstance(widget, NodeBaseWidget):

0 commit comments

Comments
 (0)