Skip to content

Commit

Permalink
doc string updates.
Browse files Browse the repository at this point in the history
  • Loading branch information
jchanvfx committed Dec 21, 2022
1 parent 4e6e84a commit fc27f2a
Show file tree
Hide file tree
Showing 3 changed files with 10 additions and 3 deletions.
6 changes: 4 additions & 2 deletions NodeGraphQt/base/node.py
Original file line number Diff line number Diff line change
Expand Up @@ -310,8 +310,10 @@ def create_property(self, name, value, items=None, range=None,
Args:
name (str): name of the property.
value (object): data.
items (list[str]): items used by widget type attr:`NodePropWidgetEnum.QCOMBO_BOX`
range (tuple or list): ``(min, max)`` values used by :attr:`NodePropWidgetEnum.SLIDER`
items (list[str]): items used by widget type
attr:`NodeGraphQt.constants.NodePropWidgetEnum.QCOMBO_BOX`
range (tuple or list): ``(min, max)`` values used by
:attr:`NodeGraphQt.constants.NodePropWidgetEnum.SLIDER`
widget_type (int): widget flag to display in the
:class:`NodeGraphQt.PropertiesBinWidget`
tab (str): name of the widget tab to display in the
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -342,6 +342,11 @@ class PropertiesBinWidget(QtWidgets.QWidget):
properties_bin = PropertiesBinWidget(parent=None, node_graph=graph)
properties_bin.show()
See Also:
:meth:`NodeGraphQt.BaseNode.add_custom_widget`,
:meth:`NodeGraphQt.NodeObject.create_property`,
:attr:`NodeGraphQt.constants.NodePropWidgetEnum`
Args:
parent (QtWidgets.QWidget): parent of the new widget.
node_graph (NodeGraphQt.NodeGraph): node graph.
Expand Down
2 changes: 1 addition & 1 deletion NodeGraphQt/nodes/base_node.py
Original file line number Diff line number Diff line change
Expand Up @@ -152,7 +152,7 @@ def add_custom_widget(self, widget, widget_type=None, tab=None):
widget (NodeBaseWidget): node widget class object.
widget_type: widget flag to display in the
:class:`NodeGraphQt.PropertiesBinWidget`
(default: :attr:`NodePropWidgetEnum.HIDDEN`).
(default: :attr:`NodeGraphQt.constants.NodePropWidgetEnum.HIDDEN`).
tab (str): name of the widget tab to display in.
"""
if not isinstance(widget, NodeBaseWidget):
Expand Down

0 comments on commit fc27f2a

Please sign in to comment.