updated some docs

Author: jchanvfx

NodeGraphQt/base/graph.py

@@ -23,17 +23,17 @@ class NodeGraph(QtCore.QObject):
     base node graph controller.
     """
 
-    #: signal triggered when a node has been created in the node graph.
+    #: signal emits the node object when a node is created in the node graph.
     node_created = QtCore.Signal(NodeObject)
-    #: signal triggered when nodes has been deleted in the node graph.
+    #: signal emits a list of node ids from the deleted nodes.
     nodes_deleted = QtCore.Signal(list)
-    #: signal triggered when a node is selected.
+    #: signal emits the node object when selected in the node graph.
     node_selected = QtCore.Signal(NodeObject)
-    #: signal triggered when a node is double clicked.
+    #: signal triggered when a node is double clicked and emits the node.
     node_double_clicked = QtCore.Signal(NodeObject)
-    #: signal for when a node has been connected.
+    #: signal for when a node has been connected emits (source port, target port).
     port_connected = QtCore.Signal(Port, Port)
-    #: signal for when a node property has changed.
+    #: signal for when a node property has changed emits (node, property name, property value).
     property_changed = QtCore.Signal(NodeObject, str, object)
     #: signal for when drop data has been added to the graph.
     data_dropped = QtCore.Signal(QtCore.QMimeData, QtCore.QPoint)

docs/widgets.rst

@@ -5,9 +5,14 @@ Widgets
 PropertiesBinWidget
 ===================
 
+The ``PropertiesBinWidget`` is a list widget for displaying and editing a
+nodes properties.
+
 .. image:: _images/prop_bin.png
     :width: 950px
 
+example
+
 .. code-block:: python
     :linenos:
 
@@ -17,7 +22,7 @@ PropertiesBinWidget
     graph = NodeGraph()
 
     # create properties bin widget.
-    properties_bin = PropertiesBinWidget(node_graph=graph)
+    properties_bin = PropertiesBinWidget(parent=None, node_graph=graph)
     properties_bin.show()
 
 ----
@@ -29,9 +34,14 @@ PropertiesBinWidget
 NodeTreeWidget
 ==============
 
+The ``NodeTreeWidget`` is a widget for displaying all registered nodes from the
+node graph with this widget a user can create nodes by dragging and dropping.
+
 .. image:: _images/nodes_tree.png
     :width: 300px
 
+example
+
 .. code-block:: python
     :linenos:
 
@@ -41,7 +51,7 @@ NodeTreeWidget
     graph = NodeGraph()
 
     # create node tree widget.
-    nodes_tree = NodeTreeWidget(node_graph=graph)
+    nodes_tree = NodeTreeWidget(parent=None, node_graph=graph)
     nodes_tree.show()
 
 ----