doc updates

Author: jchanvfx

NodeGraphQt/base/node.py

@@ -253,7 +253,14 @@ def create_property(self, name, value, items=None, range=None,
         """
         Creates a custom property to the node.
 
-        Widget Types:
+        See Also:
+            Custom node properties bin widget
+            :class:`NodeGraphQt.PropertiesBinWidget`
+
+        Hint:
+            Here are some constants variables used to define the node
+            widget type in the ``PropertiesBinWidget``.
+
             - :attr:`NodeGraphQt.constants.NODE_PROP`
             - :attr:`NodeGraphQt.constants.NODE_PROP_QLABEL`
             - :attr:`NodeGraphQt.constants.NODE_PROP_QLINEEDIT`
@@ -270,15 +277,13 @@ def create_property(self, name, value, items=None, range=None,
             - :attr:`NodeGraphQt.constants.NODE_PROP_INT`
             - :attr:`NodeGraphQt.constants.NODE_PROP_BUTTON`
 
-        See Also:
-            :class:`NodeGraphQt.PropertiesBinWidget`
-
         Args:
             name (str): name of the property.
             value (object): data.
             items (list[str]): items used by widget type ``NODE_PROP_QCOMBO``
             range (tuple)): ``(min, max)`` values used by ``NODE_PROP_SLIDER``
-            widget_type (int): widget flag to display in the ``PropertiesBinWidget``
+            widget_type (int): widget flag to display in the
+                :class:`NodeGraphQt.PropertiesBinWidget`
             tab (str): name of the widget tab to display in the properties bin.
             ext (str): file ext of ``NODE_PROP_FILE``
             funcs (list[function]) list of functions for NODE_PROP_BUTTON

NodeGraphQt/base/port.py

@@ -15,6 +15,10 @@ class Port(object):
     .. image:: ../_images/port.png
         :width: 50%
 
+    See Also:
+        For adding a ports into a node see:
+        :meth:`BaseNode.add_input`, :meth:`BaseNode.add_output`
+
     Args:
         node (NodeGraphQt.NodeObject): parent node.
         port (PortItem): graphic item used for drawing.

NodeGraphQt/widgets/node_widgets.py

@@ -30,8 +30,13 @@ def add_node_widget(self, widget):
 
 class NodeBaseWidget(QtWidgets.QGraphicsProxyWidget):
     """
-    NodeBaseWidget is the main base class for all node widgets that is
-    embedded in a :class:`NodeGraphQt.BaseNode` object.
+    This is the main wrapper class that allows a widget to be
+    added in a :class:`NodeGraphQt.BaseNode`.
+
+    If you want to add your own custom widget into a node you'll need
+    to subclass ``NodeBaseWidget`` for an example have a look at the source
+    code for the ``NodeComboBox``
+    `here <https://github.com/jchanvfx/NodeGraphQt/blob/master/NodeGraphQt/widgets/node_widgets.py#L149>`_.
     """
 
     value_changed = QtCore.Signal(str, object)
@@ -61,6 +66,10 @@ def widget(self):
         """
         Returns the embedded QWidget used in the node.
 
+        Note:
+            To add your own custom widget in a :class:`NodeGraphQt.BaseNode`
+            you must re-implement this function.
+
         Returns:
             QtWidgets.QWidget: nested QWidget
         """
@@ -71,6 +80,10 @@ def value(self):
         """
         Returns the widgets current value.
 
+        Note:
+            You must re-implement this function to get the value from your
+            custom widget.
+
         Returns:
             str: current property value.
         """
@@ -81,6 +94,9 @@ def value(self, text):
         """
         Sets the widgets current value.
 
+        Note:
+            You must re-implement this function to update your custom widget.
+
         Args:
             text (str): new text value.
         """
@@ -148,11 +164,12 @@ def get_icon(self, name):
 
 class NodeComboBox(NodeBaseWidget):
     """
-    NodeComboBox widget is subclassed from :class:`NodeBaseWidget`,
-    this widget is displayed as a ``QComboBox`` embedded in a node.
+    Displays as a ``QComboBox`` in a node.
+
+    **Inherited from:** :class:`NodeBaseWidget`
 
     .. note::
-        `To embed a ``QComboBox`` in a node see func:`
+        `To embed a` ``QComboBox`` `in a node see func:`
         :meth:`NodeGraphQt.BaseNode.add_combo_menu`
     """
 
@@ -221,11 +238,12 @@ def clear(self):
 
 class NodeLineEdit(NodeBaseWidget):
     """
-    NodeLineEdit widget is subclassed from :class:`NodeBaseWidget`,
-    this widget is displayed as a ``QLineEdit`` embedded in a node.
+    Displays as a ``QLineEdit`` in a node.
+
+    **Inherited from:** :class:`NodeBaseWidget`
 
     .. note::
-        `To embed a ``QLineEdit`` in a node see func:`
+        `To embed a` ``QLineEdit`` `in a node see func:`
         :meth:`NodeGraphQt.BaseNode.add_text_input`
     """
 
@@ -269,15 +287,16 @@ def value(self, text=''):
 
 class NodeFloatEdit(NodeBaseWidget):
     """
-    NodeFloatEdit widget is subclassed from :class:`NodeBaseWidget`,
-    this widget is displayed as a ``QLineEdit`` embedded in a node.
+    Displays as a ``QLineEdit`` in a node.
+
+    **Inherited from:** :class:`NodeBaseWidget`
 
     .. note::
-        `To embed a ``QLineEdit`` in a node see func:`
+        `To embed a` ``QLineEdit`` `in a node see func:`
         :meth:`NodeGraphQt.BaseNode.add_float_input`
     """
 
-    def __init__(self, parent=None, name='', label='', value = 0.0):
+    def __init__(self, parent=None, name='', label='', value=0.0):
         super(NodeFloatEdit, self).__init__(parent, name, label)
         self._ledit = _ValueEdit()
         self._ledit.setStyleSheet(STYLE_QLINEEDIT)
@@ -317,11 +336,12 @@ def value(self, value):
 
 class NodeIntEdit(NodeFloatEdit):
     """
-    NodeIntEdit widget is subclassed from :class:`NodeFloatEdit`,
-    this widget is displayed as a ``QLineEdit`` embedded in a node.
+    Displays as a ``QLineEdit`` in a node.
+
+    **Inherited from:** :class:`NodeBaseWidget`
 
     .. note::
-        `To embed a ``QLineEdit`` in a node see func:`
+        `To embed a` ``QLineEdit`` `in a node see func:`
         :meth:`NodeGraphQt.BaseNode.add_int_input`
     """
 
@@ -333,11 +353,12 @@ def __init__(self, parent=None, name='', label='', value=0):
 
 class NodeCheckBox(NodeBaseWidget):
     """
-    NodeCheckBox widget is subclassed from :class:`NodeBaseWidget`,
-    this widget is displayed as a ``QCheckBox`` embedded in a node.
+    Displays as a ``QCheckBox`` in a node.
+
+    **Inherited from:** :class:`NodeBaseWidget`
 
     .. note::
-        `To embed a ``QCheckBox`` in a node see func:`
+        `To embed a` ``QCheckBox`` `in a node see func:`
         :meth:`NodeGraphQt.BaseNode.add_checkbox`
     """
 
@@ -385,12 +406,13 @@ def value(self, state=False):
 
 class NodeFilePath(NodeLineEdit):
     """
-    NodeFilePath widget is subclassed from :class:`NodeLineEdit`,
-    this widget is displayed as a ``QLineEdit`` embedded in a node.
+    Displays as a ``QLineEdit`` in a node.
+
+    **Inherited from:** :class:`NodeBaseWidget`
 
     .. note::
-        `To embed a ``QLineEdit`` in a node see func:`
-        :meth:`NodeGraphQt.BaseNode.add_float_input`
+        To embed a ``QLineEdit`` in a node see:
+        :meth:`NodeGraphQt.BaseNode.add_file_input`
     """
 
     def __init__(self, parent=None, name='', label='', text='', ext='*'):